CMSControlDataSource MembersKentico 8.0 API Reference
The CMSControlDataSource type exposes the following members.
Constructors

  NameDescription
Public methodCMSControlDataSource
Default constructor
Back to Top
Methods

  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodOnlineAddedControl
Called after a child control is added to the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodOnlineAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's OnlineControlCollection object.
(Inherited from OnlineControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodOnlineApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from OnlineControl.)
Protected methodOnlineBuildProfileTree
Gathers information about the server control and delivers it to the OnlineTrace property to be displayed when tracing is enabled for the page.
(Inherited from OnlineControl.)
Public methodClearCache
Clears the cached items.
(Inherited from CMSBaseDataSource.)
Protected methodOnlineClearCachedClientID
Sets the cached OnlineClientID value to null.
(Inherited from OnlineControl.)
Protected methodOnlineClearEffectiveClientIDMode
Sets the OnlineClientIDMode property of the current control instance and of any child controls to OnlineInherit.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineConstruct
Performs design-time logic.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineCreateControlCollection
Creates a new OnlineControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from OnlineControl.)
Protected methodOnlineCreateChildControls
Called 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 OnlineControl.)
Protected methodOnlineCreateResourceBasedLiteralControl
Accesses literal strings stored in a resource. The OnlineCreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Public methodOnlineDataBind 
Binds a data source to the invoked server control and all its child controls.
(Inherited from OnlineControl.)
Protected methodOnlineDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from OnlineControl.)
Public methodOnlineDesignerInitialize
Performs any initialization steps on the user control that are required by RAD designers.
(Inherited from OnlineUserControl.)
Public methodOnlineDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from OnlineControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Protected methodOnlineEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from OnlineControl.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Protected methodOnlineEval(String, String)
Evaluates a data-binding expression using the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from OnlineControl.)
Protected methodOnlineFindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the OnlineFindControl  method.
(Inherited from OnlineControl.)
Public methodOnlineFocus
Sets input focus to a control.
(Inherited from OnlineControl.)
Protected methodOnlineFrameworkInitialize
Initializes the control that is derived from the OnlineTemplateControl class.
(Inherited from OnlineTemplateControl.)
Public methodGetCacheDependency
Gets the cache dependency for the control.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodGetDataSource 
Gets data source according to caching properties.
(Inherited from CMSBaseDataSource.)
Protected methodGetDataSource(Int32, Int32)
Gets data source according to caching properties.
(Inherited from CMSBaseDataSource.)
Protected methodGetDataSourceFromDB 
Gets data source from DB.
(Inherited from CMSBaseDataSource.)
Protected methodGetDataSourceFromDB(Int32, Int32, Int32 )
Gets data source from DB.
(Inherited from CMSBaseDataSource.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
(Overrides CMSAbstractBaseFilterControl GetDefaultCacheDependencies .)
Protected methodGetDefaultCacheKey
Gets the default cache key.
(Inherited from CMSBaseDataSource.)
Protected methodOnlineGetDesignModeState
Gets design-time data for a control.
(Inherited from OnlineControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Protected methodOnlineGetGlobalResourceObject(String, String)
Gets an application-level resource object based on the specified OnlineClassKey and OnlineResourceKey properties.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineGetGlobalResourceObject(String, String, Type, String)
Gets an application-level resource object based on the specified OnlineClassKey and OnlineResourceKey properties, object type, and property name of the resource.
(Inherited from OnlineTemplateControl.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Protected methodOnlineGetLocalResourceObject(String)
Gets a page-level resource object based on the specified OnlineResourceKey property.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineGetLocalResourceObject(String, Type, String)
Gets a page-level resource object based on the specified OnlineResourceKey property, object type, and property name.
(Inherited from OnlineTemplateControl.)
Protected methodGetRelatedData
Gets related data.
(Inherited from CMSBaseDataSource.)
Public methodOnlineGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodGetString
Returns localized string.
(Inherited from AbstractUserControl.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineGetUniqueIDRelativeTo
Returns the prefixed portion of the OnlineUniqueID property of the specified control.
(Inherited from OnlineControl.)
Public methodOnlineHasControls
Determines if the server control contains any child controls.
(Inherited from OnlineControl.)
Protected methodOnlineHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from OnlineControl.)
Public methodInitDataProperties(ICMSBaseProperties)
Initialize data properties from property object.
(Inherited from CMSAbstractBaseFilterControl.)
Public methodInitDataProperties(ICMSControlProperties)
Initialize data properties from property object.
Public methodOnlineInitializeAsUserControl
Initializes the OnlineUserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly.
(Inherited from OnlineUserControl.)
Public methodInvalidateLoadedData
Invalidate loaded data.
(Inherited from CMSBaseDataSource.)
Protected methodOnlineIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from OnlineControl.)
Public methodOnlineLoadControl(String)
Loads a OnlineControl object from a file based on a specified virtual path.
(Inherited from OnlineTemplateControl.)
Public methodOnlineLoadControl(Type,  Object )
Loads a OnlineControl object based on a specified type and constructor parameters.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineLoadControlState
Restores control-state information from a previous page request that was saved by the OnlineSaveControlState  method.
(Inherited from OnlineControl.)
Public methodLoadData
Loads data from the database according to the current values of properties.
(Inherited from CMSBaseDataSource.)
Public methodOnlineLoadTemplate
Obtains an instance of the OnlineITemplate interface from an external file.
(Inherited from OnlineTemplateControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Protected methodOnlineLoadViewState
Restores the view-state information from a previous user control request that was saved by the OnlineSaveViewState  method.
(Inherited from OnlineUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnlineMapPath
Assigns a virtual file path, either absolute or relative, to a physical file path.
(Inherited from OnlineUserControl.)
Protected methodOnlineMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from OnlineControl.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineOnAbortTransaction
Raises the OnlineAbortTransaction event.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from OnlineControl.)
Protected methodOnlineOnCommitTransaction
Raises the OnlineCommitTransaction event.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineOnDataBinding
Raises the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineOnError
Raises the OnlineError event.
(Inherited from OnlineTemplateControl.)
Protected methodOnInit
Init event handler.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodOnLoad
Load event handler.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Protected methodOnlineOnUnload
Raises the OnlineUnload event.
(Inherited from OnlineControl.)
Protected methodOnlineOpenFile
Gets a OnlineStream used to read a file.
(Inherited from OnlineControl.)
Public methodOnlineParseControl(String)
Parses an input string into a OnlineControl object on the Web Forms page or user control.
(Inherited from OnlineTemplateControl.)
Public methodOnlineParseControl(String, Boolean)
Parses an input string into a OnlineControl object on the ASP.NET Web page or user control.
(Inherited from OnlineTemplateControl.)
Protected methodPropagateProperties(ICMSBaseProperties)
Propagates given settings
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodPropagateProperties(ICMSControlProperties)
Propagates given settings
Protected methodOnlineRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from OnlineControl.)
Public methodRaiseOnFilterChanged
Run OnDataFilterChanged handler.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodRaiseOnPageBinding
Raises the page binding event.
(Inherited from CMSBaseDataSource.)
Public methodOnlineReadStringResource
Reads a string resource. The OnlineReadStringResource  method is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Public methodReBind
Evokes control databind.
(Inherited from CMSBaseDataSource.)
Protected methodRegisterOnFilterChangedHandler
Register OnFilterChanged handler
(Inherited from CMSAbstractBaseFilterControl.)
Public methodReloadData
Reload control data.
Protected methodOnlineRemovedControl
Called after a child control is removed from the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodOnlineRenderControl(HtmlTextWriter)
Outputs server control content to a provided OnlineHtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from OnlineControl.)
Protected methodOnlineRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided OnlineHtmlTextWriter object using a provided OnlineControlAdapter object.
(Inherited from OnlineControl.)
Protected methodOnlineRenderChildren
Outputs the content of a server control's children to a provided OnlineHtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from OnlineControl.)
Public methodResetFilter
Resets filter to default state.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodOnlineResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from OnlineControl.)
Public methodOnlineResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from OnlineControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodRestoreFilterState
Restores filter state from the specified object.
(Inherited from CMSAbstractBaseFilterControl.)
Protected methodOnlineSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from OnlineControl.)
Protected methodOnlineSaveViewState
Saves any user control view-state changes that have occurred since the last page postback.
(Inherited from OnlineUserControl.)
Protected methodOnlineSetDesignModeState
Sets design-time data for a control.
(Inherited from OnlineControl.)
Public methodOnlineSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from OnlineControl.)
Protected methodOnlineSetStringResourcePointer
Sets a pointer to a string resource. The OnlineSetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodSourceFilterControl_OnFilterChanged
Handles the OnFilterChanged event of the SourceFilter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public methodStoreFilterState
Stores filter state to the specified object.
(Inherited from CMSAbstractBaseFilterControl.)
Public methodOnlineTestDeviceFilter
Returns a Boolean value indicating whether a device filter applies to the HTTP request.
(Inherited from OnlineTemplateControl.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodOnlineTrackViewState
Causes tracking of view-state changes to the server control so they can be stored in the server control's OnlineStateBag object. This object is accessible through the OnlineViewState property.
(Inherited from OnlineControl.)
Protected methodOnlineWriteUTF8ResourceString
Writes a resource string to an OnlineHtmlTextWriter control. The OnlineWriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String)
Evaluates an XPath data-binding expression.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, String)
Evaluates an XPath data-binding expression using the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPathSelect(String)
Evaluates an XPath data-binding expression and returns a node collection that implements the OnlineIEnumerable interface.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPathSelect(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the OnlineIEnumerable interface.
(Inherited from OnlineTemplateControl.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldmDataSource
Data source.
(Inherited from CMSBaseDataSource.)
Back to Top
Properties

  NameDescription
Protected propertyOnlineAdapter
Gets the browser-specific adapter for the control.
(Inherited from OnlineControl.)
Public propertyOnlineApplication
Gets the OnlineApplication object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the OnlinePage or OnlineUserControl object that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineAppRelativeVirtualPath
Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineAttributes
Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
(Inherited from OnlineUserControl.)
Protected propertyOnlineAutoHandlersObsolete.
The OnlineAutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code.
(Inherited from OnlineTemplateControl.)
Protected propertyBaseProperties
Data properties
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyOnlineBindingContainer
Gets the control that contains this control's data binding.
(Inherited from OnlineControl.)
Public propertyOnlineCache
Gets the OnlineCache object that is associated with the application that contains the user control.
(Inherited from OnlineUserControl.)
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyCacheItemName
Name of the cache item the control will use.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyOnlineCachePolicy
Gets a reference to a collection of caching parameters for this user control.
(Inherited from OnlineUserControl.)
Public propertyCategoryName
Category code name for filtering documents.
Public propertyClassNames
Class name value or several values separated by semicolon.
Public propertyOnlineClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from OnlineControl.)
Public propertyOnlineClientIDMode
Gets or sets the algorithm that is used to generate the value of the OnlineClientID property.
(Inherited from OnlineControl.)
Protected propertyOnlineClientIDSeparator
Gets a character value representing the separator character used in the OnlineClientID property.
(Inherited from OnlineControl.)
Public propertyCombineWithDefaultCulture
Indicates if the documents from the default culture version should be alternatively used.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Protected propertyOnlineContext
Gets the OnlineHttpContext object associated with the server control for the current Web request.
(Inherited from OnlineControl.)
Public propertyControlContext
Control context.
(Inherited from CMSBaseDataSource.)
Protected propertyControlProperties
Data properties
Public propertyOnlineControls
Gets a OnlineControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from OnlineControl.)
Public propertyCultureCode
Culture code, such as en-us.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyOnlineDataItemContainer
Gets a reference to the naming container if the naming container implements OnlineIDataItemContainer.
(Inherited from OnlineControl.)
Public propertyOnlineDataKeysContainer
Gets a reference to the naming container if the naming container implements OnlineIDataKeysControl.
(Inherited from OnlineControl.)
Public propertyDataSource
Gets or sets source with data.
(Inherited from CMSBaseDataSource.)
Protected propertyOnlineDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from OnlineControl.)
Public propertyDisableFilterCaching
Enables or disables filter caching.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyOnlineEnableTheming
Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the OnlineTemplateControl class.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineEnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from OnlineControl.)
Protected propertyOnlineEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from OnlineControl.)
Public propertyFilterControl
Data filter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterControlPath
Gets or sets the path of the filter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilteredControl
Filtered control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterChanged
Property to set and get the Filter changed.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterIsSet
Property to get if the filter is set.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterMode
Allow to set filter mode (useful if same filter is used to filter different items)
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterName
Property to set and get the Filter name.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
Protected propertyOnlineHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from OnlineControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyCheckPermissions
Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Protected propertyOnlineChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from OnlineControl.)
Public propertyOnlineID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from OnlineControl.)
Protected propertyOnlineIdSeparator
Gets the character used to separate control identifiers.
(Inherited from OnlineControl.)
Protected propertyOnlineIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from OnlineControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyOnlineIsPostBack
Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
(Inherited from OnlineUserControl.)
Public propertyIsSelected
Gets or sets the value that indicates whether current data source contains selected item.
(Inherited from CMSBaseDataSource.)
Protected propertyOnlineIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from OnlineControl.)
Protected propertyOnlineIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from OnlineControl.)
Public propertyLoadPagesIndividually
If true, each page is loaded individually in case of paging.
(Inherited from CMSBaseDataSource.)
Protected propertyOnlineLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by OnlineID instead of index.
(Inherited from OnlineControl.)
Protected propertyMaxRecords
Maximum number of records to get from the database.
(Inherited from CMSBaseDataSource.)
Public propertyMaxRelativeLevel
Relative level of child documents that should be selected. -1 selects all child documents.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyOnlineNamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same OnlineID property value.
(Inherited from OnlineControl.)
Protected propertyOffset
Offset where the data retrieved from database should start.
(Inherited from CMSBaseDataSource.)
Public propertyOrderBy
Property to set and get the OrderBy.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyOnlinePage
Gets a reference to the OnlinePage instance that contains the server control.
(Inherited from OnlineControl.)
Public propertyPagerDataItem
Pager data item object.
(Inherited from CMSBaseDataSource.)
Public propertyPagerForceNumberOfResults
Gets or sets the number of result. Enables proceed "fake" datasets, where number of results in the dataset is not correspondent to the real number of results This property must be equal -1 if should be disabled
(Inherited from CMSBaseDataSource.)
Public propertyParameters
Hashtable with additional parameters.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyOnlineParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from OnlineControl.)
Public propertyPath
Path of the documents to be displayed. /% selects all documents.
Public propertyRelatedData
Related data.
(Inherited from CMSBaseDataSource.)
Public propertyOnlineRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from OnlineControl.)
Public propertyOnlineRequest
Gets the OnlineHttpRequest object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineResponse
Gets the OnlineHttpResponse object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertySelectedColumns
Columns which should be selected.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySelectedValue
This value is used to initialize filter control according to currently selected value.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySelectOnlyPublished
Indicates if only published documents should be displayed.
Public propertySelectTopN
Top N rows to select.
Public propertyOnlineServer
Gets the OnlineHttpServerUtility object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineSession
Gets the OnlineHttpSessionState object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyOnlineSite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from OnlineControl.)
Public propertySiteID
Property to set and get the filter SiteID.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySiteName
Property to set and get the SiteName.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyOnlineSkinID
Gets or sets the skin to apply to the control.
(Inherited from OnlineControl.)
Public propertySourceFilterControl
Gets the source filter control.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertySourceFilterName
Gets or sets the source filter name.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyStopProcessing
Stop processing.
(Inherited from CMSAbstractBaseFilterControl.)
Protected propertyOnlineSupportAutoEvents
Gets a value indicating whether the OnlineTemplateControl control supports automatic events.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineTemplateSourceDirectory
Gets the virtual directory of the OnlinePage or OnlineUserControl that contains the current server control.
(Inherited from OnlineControl.)
Public propertyToggleAdvancedModeButton
Gets button used to toggle filter's advanced mode.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyTopN
Property to set and get the Top N property.
(Inherited from CMSAbstractBaseFilterControl.)
Public propertyTotalRecords
Total number of records.
(Inherited from CMSBaseDataSource.)
Public propertyOnlineTrace
Gets the OnlineTraceContext object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUniPagerControl
Pager control.
(Inherited from CMSBaseDataSource.)
Public propertyOnlineUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from OnlineControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyValue
Filter value.
(Inherited from CMSAbstractBaseFilterControl.)
Protected propertyOnlineViewState
Gets 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 OnlineControl.)
Protected propertyOnlineViewStateIgnoresCase
Gets a value that indicates whether the OnlineStateBag object is case-insensitive.
(Inherited from OnlineControl.)
Public propertyOnlineViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from OnlineControl.)
Public propertyOnlineVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from OnlineControl.)
Public propertyWhereCondition
Property to set and get the WhereCondition.
(Inherited from CMSAbstractBaseFilterControl.)
Back to Top
Events

  NameDescription
Public eventOnlineAbortTransaction
Occurs when a user ends a transaction.
(Inherited from OnlineTemplateControl.)
Public eventOnlineCommitTransaction
Occurs when a transaction completes.
(Inherited from OnlineTemplateControl.)
Public eventOnlineDataBinding
Occurs when the server control binds to a data source.
(Inherited from OnlineControl.)
Public eventOnlineDisposed
Occurs 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 OnlineControl.)
Public eventOnlineError
Occurs when an unhandled exception is thrown.
(Inherited from OnlineTemplateControl.)
Public eventOnlineInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from OnlineControl.)
Public eventOnlineLoad
Occurs when the server control is loaded into the OnlinePage object.
(Inherited from OnlineControl.)
Public eventOnFilterChanged
Filter change handler.
(Inherited from CMSAbstractBaseFilterControl.)
Public eventOnPageBinding
Occurs when the control bind data.
(Inherited from CMSBaseDataSource.)
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
(Inherited from CMSBaseDataSource.)
Public eventOnlinePreRender
Occurs after the OnlineControl object is loaded but prior to rendering.
(Inherited from OnlineControl.)
Public eventOnlineUnload
Occurs when the server control is unloaded from memory.
(Inherited from OnlineControl.)
Back to Top
See Also