Version

WebHierarchicalDataSource Class Members

The following tables list the members exposed by WebHierarchicalDataSource.

Public Constructors
Public Properties
 NameDescription
Public PropertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl object that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from System.Web.UI.Control)
Public PropertyClientIDModeGets or sets the algorithm that is used to generate the value of the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Public PropertyControlsGets a System.Web.UI.ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyControlStyleCreatedGets a value indicating whether a System.Web.UI.WebControls.Style object has been created for the System.Web.UI.WebControls.WebControl.ControlStyle property. This property is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyCustomAJAXResponseContainer for values passed to client within AJAX response. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyDataRelationsThe collection of DataRelation objects, that define the relations between different DataViews.  
Public PropertyDataSourceGets or sets the object from which the data-bound control retrieves its list of data items. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyDataSourceObjectGets an object that implements the System.Web.UI.IDataSource interface, which provides access to the object's data content. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public PropertyDataViewsThe collection of DataView objects, that take part in defining the hierarchy.  
Public PropertyEnableAjaxViewStateGets sets ability to maintain view state of controls on page if their properties were modified while asynchronous postback of this control. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyEnableEmbeddedJavaScriptInstructs the control to load its embedded Java Script. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from System.Web.UI.Control)
Public PropertyInsecureSubmitTokensGets sets list of insecure strings as array.

That property is designed to protect application from scripting vulnerability. When request comes from client and the value of the hidden field contains insecure tokens, then all changes on client are discarded. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyInsecureSubmitTokensAsStringGets sets list of insecure strings separated by the "|" character.

That property is designed to protect application from scripting vulnerability. When request comes from client and the value of the hidden field contains insecure tokens, then all changes on client are discarded. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyItemTypeGets or sets the name of the data item type for strongly typed data binding. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public PropertyNamingContainerGets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same System.Web.UI.Control.ID property value. (Inherited from System.Web.UI.Control)
Public PropertyOptimizeCollectionsStateThe collections client state will be stored in the view state and the client collections will not be sent from the client on postback. This will increase page size in terms of view state, but will decrease the postback time numerously, because the collections state will not be uploaded from the client. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyPageGets a reference to the System.Web.UI.Page instance that contains the server control. (Inherited from System.Web.UI.Control)
Public PropertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from System.Web.UI.Control)
Public PropertyRenderer (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from System.Web.UI.Control)
Public PropertyRootDataViewIDThe value of the DataView ID that will serve as a root for the hierarchical datasource control. If not specified, the first DataView is used.  
Public PropertyRunBot (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public PropertySelectMethodThe name of the method to call in order to read data. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public PropertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from System.Web.UI.Control)
Public PropertyStyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from System.Web.UI.WebControls.WebControl)
Public PropertySupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's System.Web.UI.WebControls.WebControl.IsEnabled property is false. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Public PropertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from System.Web.UI.Control)
Public PropertyTemplateSourceDirectoryGets the virtual directory of the System.Web.UI.Page or System.Web.UI.UserControl that contains the current server control. (Inherited from System.Web.UI.Control)
Public PropertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from System.Web.UI.Control)
Public PropertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from System.Web.UI.Control)
Public PropertyViewStateModeGets or sets the view-state mode of this control. (Inherited from System.Web.UI.Control)
Protected Properties
 NameDescription
Protected PropertyAdapterGets the browser-specific adapter for the control. (Inherited from System.Web.UI.Control)
Protected PropertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from System.Web.UI.Control)
Protected PropertyClientIDSeparatorGets a character value representing the separator character used in the System.Web.UI.Control.ClientID property. (Inherited from System.Web.UI.Control)
Protected PropertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from System.Web.UI.Control)
Protected PropertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from System.Web.UI.Control)
Protected PropertyIdSeparatorGets the character used to separate control identifiers. (Inherited from System.Web.UI.Control)
Protected PropertyInitializedGets a value indicating whether the data-bound control has been initialized. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Protected PropertyIsBoundUsingDataSourceIDGets a value indicating whether the System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID property is set. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Protected PropertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from System.Web.UI.Control)
Protected PropertyIsUsingModelBindersGets a value that indicates whether model binding is in use. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected PropertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by System.Web.UI.Control.ID instead of index. (Inherited from System.Web.UI.Control)
Protected PropertyRequiresDataBindingGets or sets a value indicating whether the System.Web.UI.WebControls.BaseDataBoundControl.DataBind method should be called. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected PropertySelectArgumentsGets a System.Web.UI.DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected PropertyStyleBotProvides the Control with access to style support services provided by the StyleBot class. By separating these services from the control itself, there is no requirement that a particular control must inherit from a specific base class in order to benefit from the services provided. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected PropertyTagKeyGets the System.Web.UI.HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected PropertyViewStateGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from System.Web.UI.Control)
Protected PropertyViewStateIgnoresCaseGets a value that indicates whether the System.Web.UI.StateBag object is case-insensitive. (Inherited from System.Web.UI.Control)
Public Methods
 NameDescription
Public MethodApplyStyleCopies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from System.Web.UI.Control)
Public MethodClearTemplates (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodCopyBaseAttributesCopies the properties not encapsulated by the System.Web.UI.WebControls.WebControl.Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodDataBindOverloaded. Overridden.   
Public MethodDispose (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodEnsureTemplatesEnsures the templates. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodFindControlOverloaded. Searches the current naming container for a server control with the specified id parameter. (Inherited from System.Web.UI.Control)
Public MethodFocusSets input focus to a control. (Inherited from System.Web.UI.Control)
Public MethodGetChildDataViewIDsGets all child DataViews based on a parent DataView.ID  
Public MethodGetDataViewGets the data view. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodGetHierarchicalSchema  
Public MethodGetRootDataViewIDsGet root DataView IDs  
Public MethodGetRootDataViews  
Public MethodGetRouteUrlOverloaded. Gets the URL that corresponds to a set of route parameters. (Inherited from System.Web.UI.Control)
Public MethodGetScriptDescriptorsGets a collection of script descriptors that represent ECMAScript (JavaScript) client components. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodGetScriptReferencesGets a collection of System.Web.UI.ScriptReference objects that define script resources that the control requires. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodGetUniqueIDRelativeToReturns the prefixed portion of the System.Web.UI.Control.UniqueID property of the specified control. (Inherited from System.Web.UI.Control)
Public MethodGetViewSchema  
Public MethodHasControlsDetermines if the server control contains any child controls. (Inherited from System.Web.UI.Control)
Public MethodLoadPostDataIf any properties, objects, or collections were modified on the client, their transacation lists are loaded here. Also, if this is a Callback, it is where CallbackCreated is called from. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodMergeStyleCopies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRaisePostDataChangedEventUsed to notify the ASP.Net application that the state of the control has changed. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Public MethodRemoveDataViewSubTreeRecursively remove the specified target DataView, its DataRelations and child DataViews. This is typically used internally by WHDS.  
Public MethodRenderBeginTagRenders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodRenderControlOverloaded. Outputs server control content to a provided System.Web.UI.HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from System.Web.UI.Control)
Public MethodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Public MethodResolveClientUrlGets a URL that can be used by the browser. (Inherited from System.Web.UI.Control)
Public MethodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from System.Web.UI.Control)
Public MethodSetRenderMethodDelegateAssigns an event handler delegate to render the server control and its content into its parent control. (Inherited from System.Web.UI.Control)
Protected Methods
 NameDescription
Protected MethodAddAttributesToRenderAdds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's System.Web.UI.ControlCollection object. (Inherited from System.Web.UI.Control)
Protected MethodBuildProfileTreeGathers information about the server control and delivers it to the System.Web.UI.Page.Trace property to be displayed when tracing is enabled for the page. (Inherited from System.Web.UI.Control)
Protected MethodCallbackCreatedCalled during LoadPostData during a Callback. This method should be used to perform any operations neccessary for the callback. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodCallbackRenderCalled during the Page's Render during a Callback. This method should be used to render any html or objects that needs to be sent down in the Callback's response. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodClearCachedClientIDSets the cached System.Web.UI.Control.ClientID value to a null reference (Nothing in Visual Basic). (Inherited from System.Web.UI.Control)
Protected MethodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodClearDataItemsCalled by DataBinding Fx to tell a control to clear its data items in preparation for databinding. Derived controls override the ClearDataItems virtual method to carry out the clearing of their items according to its needs. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodClearEffectiveClientIDModeSets the System.Web.UI.Control.ClientIDMode property of the current control instance and of any child controls to System.Web.UI.ClientIDMode.Inherit. (Inherited from System.Web.UI.Control)
Protected MethodConfirmInitStateSets the initialized state of the data-bound control. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Protected MethodCreateChildControlsCalled by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodCreateClientEventsControl which exposes ClientEvents that must override that method and return instance of ClientEvents object. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodCreateControlCollectionCreates a new System.Web.UI.ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from System.Web.UI.Control)
Protected MethodCreateControlStyleCreates the style object that is used internally by the System.Web.UI.WebControls.WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from System.Web.UI.WebControls.WebControl)
Protected MethodCreateDataBindingManager (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodCreateDataSourceObjectCreates the data source object. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodCreateDataSourceSelectArgumentsCreates DataSourceSelectArguments specific to the control. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodCreateRendererOverridden. A virtual method called by the base Aikido framework when a renderer is required for the control. Derived classes may override this method in order to provide specific rendering markup. Many of the rendering methods within the Renderer class may also be overridable in order to customize specific aspects of the rendering.  
Protected MethodCreateRunBotOverridden. A virtual method called by the base Aikido framework when the RunBot is required for the control. Derived classes may override this method in order to provide extra functionality to the RunBot. Many of the methods within the RunBot class may also be overridable in order to add additional logic to the control.  
Protected MethodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from System.Web.UI.Control)
Protected MethodEnsureDataBoundCalls the System.Web.UI.WebControls.BaseDataBoundControl.DataBind method if the System.Web.UI.WebControls.BaseDataBoundControl.DataSourceID property is set and the data-bound control is marked to require binding. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from System.Web.UI.Control)
Protected MethodGetClientEventsObjectControl which exposes ClientEvents should return the method within its ClientEvents property with a proper typecast. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodGetDataRetrieves a System.Web.UI.DataSourceView object that the data-bound control uses to perform data operations. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodGetDataSourceAlters base class' method to provide a reference to the Infragistics.Web.UI.Framework.Data.DataSourceObject object that wraps the original data source. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodGetDataSourceObjectOverloaded. Gets the data source object. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodGetDesignModeStateGets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from System.Web.UI.Control)
Protected MethodIsLiteralContentDetermines if the server control holds only literal content. (Inherited from System.Web.UI.Control)
Protected MethodLoadViewStateOverridden.   
Protected MethodMarkAsDataBoundSets the state of the control in view state as successfully bound to data. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected MethodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from System.Web.UI.Control)
Protected MethodOnCreatingModelDataSourceRaises the System.Web.UI.WebControls.DataBoundControl.CreatingModelDataSource event. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected MethodOnDataBindingRaises the System.Web.UI.Control.DataBinding event. (Inherited from System.Web.UI.Control)
Protected MethodOnDataBoundRaises the System.Web.UI.WebControls.BaseDataBoundControl.DataBound event. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Protected MethodOnDataPropertyChangedRebinds the data-bound control to its data after one of the base data source identification properties changes. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected MethodOnDataSourceViewChangedRaises the System.Web.UI.DataSourceView.DataSourceViewChanged event. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected MethodOnInit (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodOnPagePreLoadSets the initialized state of the data-bound control before the control is loaded. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected MethodOnPreRender (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodPerformSelectRetrieves data from the associated data source. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Protected MethodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from System.Web.UI.Control)
Protected MethodRender (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodRenderContentsOverride the WebControl RenderContents method to redirect rendering to the appropriate renderer. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodResetUnboundVarsThis resets this private variables storing unbound column information to null. (Inherited from Infragistics.Web.UI.Framework.Data.FlatDataBoundControl)
Protected MethodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from System.Web.UI.Control)
Protected MethodSaveViewStateOverridden.   
Protected MethodSetDesignModeStateSets design-time data for a control. (Inherited from System.Web.UI.Control)
Protected MethodTrackViewStateOverridden.   
Protected MethodValidateDataSourceVerifies that the object a data-bound control binds to is one it can work with. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public Events
 NameDescription
Public EventCallingDataMethodsOccurs when data methods are being called. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public EventCreatingModelDataSourceOccurs when the System.Web.UI.WebControls.ModelDataSource object is being created. (Inherited from System.Web.UI.WebControls.DataBoundControl)
Public EventDataBindingOccurs when the server control binds to a data source. (Inherited from System.Web.UI.Control)
Public EventDataBoundOccurs after the server control binds to a data source. (Inherited from System.Web.UI.WebControls.BaseDataBoundControl)
Public EventDataSourceChanged  
Public EventDeleted  
Public EventDeleting  
Public EventDisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from System.Web.UI.Control)
Public EventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from System.Web.UI.Control)
Public EventInserted  
Public EventInserting  
Public EventLoadOccurs when the server control is loaded into the System.Web.UI.Page object. (Inherited from System.Web.UI.Control)
Public EventPreRenderOccurs after the System.Web.UI.Control object is loaded but prior to rendering. (Inherited from System.Web.UI.Control)
Public EventUnloadOccurs when the server control is unloaded from memory. (Inherited from System.Web.UI.Control)
Public EventUpdated  
Public EventUpdating  
Public EventViewStateLoadedThis event will be raised after WebHierarchicalDataSource loads its view state.  
See Also