RadOrgChart
RadOrgChart is a flexible tool for visualization of organizational structures and hierarchies.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[TelerikToolboxCategory("Visualization")]
[ToolboxBitmap(typeof(RadOrgChart), "Toolbox.Icons.OrgChart.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadOrgChart", "Telerik.Web.UI.OrgChart.RadOrgChartScripts.js")]
[EmbeddedSkin("OrgChart", typeof(RadOrgChart))]
[EmbeddedSkin("OrgChart", "Default", typeof(RadOrgChart))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadOrgChart))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
public class RadOrgChart : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IOrgChartNodeContainer, IXmlSerializable, IPostBackEventHandler, ICallbackEventHandlerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadOrgChart...
Implements:
Inherited Members
Constructors
public RadOrgChart()Properties
Allows dragging of GroupItems (except in Simple Binding)
public bool AllowGroupItemDragging { get; set; }The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }Overrides:
Gets or sets the data field holding the Collapsed property for the currently bound Node.
public string DataCollapsedField { get; set; }Gets or sets the data field holding the unique identifier for a Node.
public string DataFieldID { get; set; }Gets or sets the data field holding the ID of the parent Node.
public string DataFieldParentID { get; set; }Gets or sets the data field holding the ImageAltText property for the currently bound GroupItem.
public string DataImageAltTextField { get; set; }Gets or sets the data field holding an image URL for the currently bound GroupItem.
public string DataImageUrlField { get; set; }Gets or sets the data field holding the Text of the currently bound GroupItem.
public string DataTextField { get; set; }Gets or sets default image URL for every GroupItem image.
public string DefaultImageUrl { get; set; }When GroupItem's image URL is not set a default image is rendered for every OrgChartGroupItem.
Gets or sets whether to render a default image for every OrgChartGroupItem.
public bool DisableDefaultImage { get; set; }Gets or sets whether to enable collapsing and expanding of the Nodes
public bool EnableCollapsing { get; set; }Gets or sets whether to enable drag and drop
public bool EnableDragAndDrop { get; set; }Gets or sets whether to enable drill down functionality of the RadOrgChart.
public bool EnableDrillDown { get; set; }Gets or sets whether to enable collapsing and expanding the GroupItems of a Node.
public bool EnableGroupCollapsing { get; set; }The property takes effect if there is more than one item in a Node. In SimpleBinding is ignored.
Gets or sets the number of columns in all Node's visualization, except these that have their ColumnCount property set locally.
public int GroupColumnCount { get; set; }Simply breaks the single-line presentation of the Node (group) in RadOrgChart on multiple lines.
Gets or sets OrgChartGroupEnabledBinding settings for RadOrgChart.
[PersistenceMode(PersistenceMode.InnerProperty)]
public OrgChartGroupEnabledBinding GroupEnabledBinding { get; set; }Gets or sets template for all items that doesn't have template nor does their node.
[TemplateContainer(typeof(OrgChartGroupItemRendererBase))]
[PersistenceMode(PersistenceMode.InnerDefaultProperty)]
public ITemplate ItemTemplate { get; set; }Gets or Sets LoadOnDemand state
public virtual OrgChartLoadOnDemand LoadOnDemand { get; set; }Gets or sets the maximum depth of the RadOrgChart hierarchy which will be binded.
public int MaxDataBindDepth { get; set; }Gets OrgChart's child OrgChartNodeCollection.
[PersistenceMode(PersistenceMode.InnerProperty)]
public OrgChartNodeCollection Nodes { get; }Implements:
Gets or sets a value indicating the client-side event handler that is called when the OrgChartGroupItemCollection is populated (for example by callback).
public string OnClientGroupPopulated { get; set; }Gets or sets a value indicating the client-side event handler that is called when the OrgChartGroupItemCollection is about to be populated (for example by callback).
public string OnClientGroupPopulating { get; set; }Gets or sets a value indicating the client-side event handler that is called when the OrgChartGroupItemCollection populating failed (for example by callback).
public string OnClientGroupPopulationFailed { get; set; }Gets or sets a value indicating the client-side event handler that is called when the OrgChartNodeCollection is populated (for example by callback).
public string OnClientNodePopulated { get; set; }Gets or sets a value indicating the client-side event handler that is called when the OrgChartNodeCollection is about to be populated (for example by callback).
public string OnClientNodePopulating { get; set; }Gets or sets a value indicating the client-side event handler that is called when the OrgChartNodeCollection populating failed (for example by callback).
public string OnClientNodePopulationFailed { get; set; }public Orientation Orientation { get; set; }Gets or sets whether to persist expand/collapse state after a postback.
public bool PersistExpandCollapseState { get; set; }Gets OrgChartRenderedFieldsSettings settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public OrgChartRenderedFieldsSettings RenderedFields { get; }protected override bool SupportsRenderingMode { get; }Overrides:
protected override HtmlTextWriterTag TagKey { get; }Overrides:
[PersistenceMode(PersistenceMode.InnerProperty)]
public OrgChartWebServiceBindings WebServiceBindings { get; set; }Methods
Collapse all Groups in the RadOrgChart
public void CollapseAllGroups()Collapse all Nodes in the RadOrgChart
public void CollapseAllNodes()Collapse Groups by criteria (lambda)
public void CollapseGroups(RadOrgChart.OrgChartExpandCollapseNodeCriteria criteria)Collapse Nodes by criteria (lambda)
public void CollapseNodes(RadOrgChart.OrgChartExpandCollapseNodeCriteria criteria)public override void DataBind()Overrides:
protected override void DescribeClientEvents(IScriptDescriptor descriptor)Overrides:
protected override void DescribeClientProperties(IScriptDescriptor descriptor)Overrides:
Expand all Groups in the RadOrgChart
public void ExpandAllGroups()Expand all Nodes in the RadOrgChart
public void ExpandAllNodes()Expand Groups by criteria (lambda)
public void ExpandGroups(RadOrgChart.OrgChartExpandCollapseNodeCriteria criteria)Expand Nodes by criteria (lambda)
public void ExpandNodes(RadOrgChart.OrgChartExpandCollapseNodeCriteria criteria)Returns all GroupItems in the RadOrgChart.
public IEnumerable<OrgChartGroupItem> GetAllGroupItems()IEnumerable<OrgChartGroupItem>
Collection of OrgChartGroupItem
Returns items by some criteria (lambda).
[Obsolete("This method is obsolete. Please use the GetGroupItems(OrgChartGroupItemCriteria criteria) method instead.")]
public IEnumerable<OrgChartGroupItem> GetAllGroupItems(RadOrgChart.OrgChartGroupItemCriteria criteria)Lambda expression
Returns:IEnumerable<OrgChartGroupItem>
Collection of OrgChartGroupItem
Returns all Nodes in the RadOrgChart.
Returns items by some criteria (lambda).
public IEnumerable<OrgChartGroupItem> GetGroupItems(RadOrgChart.OrgChartGroupItemCriteria criteria)Lambda expression
Returns:IEnumerable<OrgChartGroupItem>
Collection of OrgChartGroupItem
Gets a node by hierarchical index
public OrgChartNode GetNodeByHierarchicalIndex(int[] nodeIndexes)If the node does not exist the returned value is null.
Returns nodes by some criteria (lambda).
public IEnumerable<OrgChartNode> GetNodes(RadOrgChart.OrgChartNodeCriteria criteria)Deserializes OrgChart from XML file.
public void LoadContentFile(string xmlFileName)Relative or virtual path of the loaded Xml file.
Deserializes OrgChart from XML string.
protected virtual void OnDrillDown(OrgChartDrillDownEventArguments e)protected virtual void OnGroupExpandCollapse(OrgChartGroupExpandCollapseEventArguments e)protected virtual void OnGroupItemDataBound(OrgChartGroupItemDataBoundEventArguments e)protected virtual void OnGroupItemDrop(OrgChartGroupItemDropEventArguments e)protected virtual void OnNodeDataBound(OrgChartNodeDataBoundEventArguments e)protected virtual void OnNodeDrop(OrgChartNodeDropEventArguments e)protected virtual void OnNodeExpandCollapse(OrgChartNodeExpandCollapseEventArguments e)protected override void RenderContents(HtmlTextWriter writer)Overrides:
Saves the client state data
Events
Occurs when a drill-down action is performed on a node in the OrgChart.
public event OrgChartDrillDownEventHandler DrillDownOccurs when a group is expanded or collapsed in the OrgChart.
public event OrgChartGroupExpandCollapseEventHandler GroupExpandCollapseOccurs when a group item is data-bound in the OrgChart.
public event OrgChartGroupItemDataBoundEventHandler GroupItemDataBoundOccurs when a group item is dropped onto a node in the OrgChart.
public event OrgChartGroupItemDropEventHandler GroupItemDropOccurs when a node is data-bound in the OrgChart.
public event OrgChartNodeDataBoundEventHandler NodeDataBoundOccurs when a node is dropped onto another node in the OrgChart.
public event OrgChartNodeDropEventHandler NodeDropOccurs when a node is expanded or collapsed in the OrgChart.
public event OrgChartNodeExpandCollapseEventHandler NodeExpandCollapse