CMSPagePlaceholder MembersKentico 8.1 API Reference
The CMSPagePlaceholder type exposes the following members.
Constructors

  NameDescription
Public methodCMSPagePlaceholder 
Constructor.
Public methodCMSPagePlaceholder(CMSPortalManager)
Constructor, initializes the parent portal manager.
Back to Top
Methods

  NameDescription
Protected methodOnlineAddedControl
Called after a child control is added to the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
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 methodAppend( String )
Appends the given content to the placeholder
(Inherited from CMSPlaceHolder.)
Public methodAppend(Control)
Appends the given control to the placeholder
(Inherited from CMSPlaceHolder.)
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 methodClear
Clears the placeholder content
(Inherited from CMSPlaceHolder.)
Public methodClearCache
Clears the cache of the placeholder.
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 methodOnlineCreateControlCollection
Creates a new OnlineControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from OnlineControl.)
Protected methodCreateChildControls
Initializes the child controls.
(Overrides OnlineControl CreateChildControls .)
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 methodOnlineDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from OnlineControl.)
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.)
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 methodFindAllWebParts
Finds all web parts of specified type.
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 methodFindWebPart(String)
Finds the web part with specific name.
Public methodFindWebPart(Type)
Finds the web part with specific type (first web part).
Public methodFindZone
Finds the zone by its ID.
Protected methodFinishCurrent
Appends the given content to the placeholder
(Inherited from CMSPlaceHolder.)
Public methodOnlineFocus
Sets input focus to a control.
(Inherited from OnlineControl.)
Protected methodOnlineGetDesignModeState
Gets design-time data for a control.
(Inherited from OnlineControl.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetImageUrl
Gets UI image relative path.
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 methodGetSpellCheckFields
Returns the array list of the field IDs (Client IDs of the inner controls) that should be spell checked.
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.)
Protected methodOnlineIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from OnlineControl.)
Public methodLoadContent
Load the page content to the placeholder.
Protected methodOnlineLoadControlState
Restores control-state information from a previous page request that was saved by the OnlineSaveControlState  method.
(Inherited from OnlineControl.)
Public methodLoadLayout
Loads the given layout.
Public methodLoadOrphanedZones
Loads the orphaned zones to the.
Public methodLoadRegionsContent
Loads the editable regions content.
Public methodLoadTextLayout
Loads the given text layout.
Protected methodLoadViewState
Load ViewState event handler.
(Overrides OnlineControl LoadViewState(Object).)
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 methodOnlineOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from OnlineControl.)
Protected methodOnDataBinding
Databinding event.
(Overrides OnlineControl OnDataBinding(EventArgs).)
Protected methodOnInit
Init event handler
(Overrides CMSPlaceHolder OnInit(EventArgs).)
Protected methodOnLoad
Load event handler.
(Overrides OnlineControl OnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler
(Inherited from CMSPlaceHolder.)
Protected methodOnlineOnUnload
Raises the OnlineUnload event.
(Inherited from OnlineControl.)
Protected methodOnlineOpenFile
Gets a OnlineStream used to read a file.
(Inherited from OnlineControl.)
Protected methodOnlineRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from OnlineControl.)
Public methodStatic memberRegisterEditLayoutScript
Registers edit layout script for specified control
Public methodReloadControls
Reload the page controls.
Public methodReloadData
Causes reloading the data, override to implement the data reloading procedure.
Protected methodOnlineRemovedControl
Called after a child control is removed from the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Protected methodRender
Renders the control.
(Overrides OnlineControl Render(HtmlTextWriter).)
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 methodRequiresWebPartManagement
Returns true if the web part management support is required.
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 methodOnlineResolveUrl
Converts a URL into one that is usable on the requesting client.
(Inherited from OnlineControl.)
Public methodSaveContent
Saves the page content to the page info.
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 server control view-state changes that have occurred since the time the page was posted back to the server.
(Inherited from OnlineControl.)
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.)
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.)
Public methodValidate
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 fieldlblTitle
Control title.
Protected fieldmAllowDesignModeActions
If true, placeholder allows the design mode actions.
Protected fieldmCMSEditableControls
ArrayList of the editable controls located under current placeholder.
Protected fieldmDesignEnabled
If true, placeholder is enabled in design mode.
Protected fieldmChildPagePlaceholders
Child page placeholders.
Protected fieldmIsAuthorized
Indicates whether user is authorized to read the content when in live site mode.
Protected fieldmLayoutInfo
Placeholder level layout info.
Protected fieldmNoLayoutPlaceholder
Placeholder to supply window to the next page level when layout not defined.
Protected fieldmPageLayout
Parent page layout.
Protected fieldmPageLevel
Page level of the Placeholder.
Protected fieldmPagePlaceholder
Parent page placeholder.
Protected fieldmPageTemplateInfo
Placeholder level page template layout info.
Protected fieldmPortalManager
Parent portal manager.
Protected fieldmSiblingPagePlaceholders
Sibling page placeholders.
Protected fieldmViewMode
If set, the placeholder has overridden ViewMode.
Protected fieldpnlDesignContent
Design mode content container.
Protected fieldpnlDesignHeader
Design mode header container.
Protected fieldpnlPlaceholder
Overall container.
Back to Top
Properties

  NameDescription
Protected propertyOnlineAdapter
Gets the browser-specific adapter for the control.
(Inherited from OnlineControl.)
Public propertyAllowDesignModeActions
If true, placeholder allows the design mode actions.
Public propertyOnlineAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the OnlinePage or OnlineUserControl object that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineBindingContainer
Gets the control that contains this control's data binding.
(Inherited from OnlineControl.)
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
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 propertyCMSEditableControls
Returns the array of the editable controls.
Protected propertyOnlineContext
Gets the OnlineHttpContext object associated with the server control for the current Web request.
(Inherited from OnlineControl.)
Public propertyOnlineControls
Gets a OnlineControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from OnlineControl.)
Public propertyCssClass
CSS class for the envelope
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 propertyDesignEnabled
If true, placeholder is enabled in design mode.
Protected propertyOnlineDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from OnlineControl.)
Public propertyDisplayHeader
If true, the page placeholder displays header in design mode
Public propertyOnlineEnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from OnlinePlaceHolder.)
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 propertyHasExternalContent
If true, placeholder is using external content (does not load the layout if available and uses the page info if set).
Protected propertyOnlineHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from OnlineControl.)
Public propertyHidePageTemplateName
If true, the placeholder hides the page template name
Public propertyCheckPermissions
If true, placeholder checks access permissions for the editable web parts content.
Protected propertyOnlineChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from OnlineControl.)
Public propertyChildPagePlaceholders
Returns the table of all the inner placeholders.
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.)
Public propertyIsAuthorized
Returns true if the user is authorized for the document.
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 CMSPlaceHolder.)
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 propertyLayout
Returns the layout control.
Public propertyLayoutInfo
Returns the layout information.
Public propertyLayoutTemplate
Layout template, if set, the given layout is used.
Protected propertyOnlineLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by OnlineID instead of index.
(Inherited from OnlineControl.)
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.)
Public propertyOnlinePage
Gets a reference to the OnlinePage instance that contains the server control.
(Inherited from OnlineControl.)
Public propertyPageInfo
Page info.
Public propertyPageLevel
Page level.
Public propertyPagePlaceholder
Parent page placeholder.
Public propertyPagePlaceholderID
Page placeholder ID
Public propertyPageTemplateInfo
Returns the page template information.
Public propertyOnlineParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from OnlineControl.)
Public propertyPortalManager
Parent portal manager.
Public propertyOnlineRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from OnlineControl.)
Public propertyRoot
If true, the placeholder is the main (root) placeholder on the page.
Public propertyShortID
Short ID of the control.
(Inherited from CMSPlaceHolder.)
Public propertySiblingPagePlaceholders
Returns the table of all the sibling page placeholders (page placeholders on the same level).
Public propertyOnlineSite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from OnlineControl.)
Public propertySiteName
Site code name.
Public propertyOnlineSkinID
Gets or sets the skin to apply to the control.
(Inherited from OnlineControl.)
Public propertyOnlineTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from OnlineControl.)
Public propertyTemplateInstance
Returns page template instance structure.
Public propertyOnlineTemplateSourceDirectory
Gets the virtual directory of the OnlinePage or OnlineUserControl that contains the current server control.
(Inherited from OnlineControl.)
Public propertyOnlineUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from OnlineControl.)
Public propertyUsingDefaultDocument
If true, placeholder is using default document.
Public propertyUsingDefaultPage
Indicates whether the placeholder is using either default document or default page template.
Public propertyUsingDefaultPageTemplate
If true, placeholder is using default page template.
Public propertyViewMode
Page mode of the current placeholder page.
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 propertyWebPartZones
Web part zones collection.
Back to Top
Events

  NameDescription
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 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 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