The CMSPagePlaceholder type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
CMSPagePlaceholder |
Constructor.
| |
CMSPagePlaceholder(CMSPortalManager) |
Constructor, initializes the parent portal manager.
|
Methods
Name | Description | |
---|---|---|
AddedControl | (Inherited from Control.) | |
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) | |
Append( String ) |
Appends the given content to the placeholder
(Inherited from CMSPlaceHolder.) | |
Append(Control) |
Appends the given control to the placeholder
(Inherited from CMSPlaceHolder.) | |
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) | |
BuildProfileTree | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) | |
Clear |
Clears the placeholder content
(Inherited from CMSPlaceHolder.) | |
ClearCache |
Clears the cache of the placeholder.
| |
ClearCachedClientID | Sets the cached ClientID value to null. (Inherited from Control.) | |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) | |
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) | |
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) | |
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) | |
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) | |
CreateChildControls |
Initializes the child controls.
(Overrides Control CreateChildControls .) | |
DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) | |
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) | |
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) | |
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) | |
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) | |
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FindAllWebParts |
Finds all web parts of specified type.
| |
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) | |
FindControl(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 FindControl method. (Inherited from Control.) | |
FindWebPart(String) |
Finds the web part with specific name.
| |
FindWebPart(Type) |
Finds the web part with specific type (first web part).
| |
FindZone |
Finds the zone by its ID.
| |
FinishCurrent |
Appends the given content to the placeholder
(Inherited from CMSPlaceHolder.) | |
Focus | Sets input focus to a control. (Inherited from Control.) | |
GetDesignModeState | Gets design-time data for a control. (Inherited from Control.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetImageUrl |
Gets UI image relative path.
| |
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetSpellCheckFields |
Returns the array list of the field IDs (Client IDs of the inner controls) that should be spell checked.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) | |
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) | |
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) | |
IsLiteralContent | Determines if the server control holds only literal content. (Inherited from Control.) | |
LoadContent |
Load the page content to the placeholder.
| |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) | |
LoadLayout |
Loads the given layout.
| |
LoadOrphanedZones |
Loads the orphaned zones to the.
| |
LoadRegionsContent |
Loads the editable regions content.
| |
LoadTextLayout |
Loads the given text layout.
| |
LoadViewState |
Load ViewState event handler.
(Overrides Control LoadViewState(Object).) | |
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) | |
OnDataBinding |
Databinding event.
(Overrides Control OnDataBinding(EventArgs).) | |
OnInit |
Init event handler
(Overrides CMSPlaceHolder OnInit(EventArgs).) | |
OnLoad |
Load event handler.
(Overrides Control OnLoad(EventArgs).) | |
OnPreRender |
PreRender event handler
(Inherited from CMSPlaceHolder.) | |
OnUnload | Raises the Unload event. (Inherited from Control.) | |
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) | |
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) | |
RegisterEditLayoutScript |
Registers edit layout script for specified control
| |
ReloadControls |
Reload the page controls.
| |
ReloadData |
Causes reloading the data, override to implement the data reloading procedure.
| |
RemovedControl | (Inherited from Control.) | |
Render |
Renders the control.
(Overrides Control Render(HtmlTextWriter).) | |
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) | |
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) | |
RequiresWebPartManagement |
Returns true if the web part management support is required.
| |
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) | |
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) | |
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) | |
SaveContent |
Saves the page content to the page info.
| |
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) | |
SaveViewState | Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) | |
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) | |
SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackViewState | Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property. (Inherited from Control.) | |
Validate |
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
|
Extension Methods
Name | Description | |
---|---|---|
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
CallHandled |
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.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
Name | Description | |
---|---|---|
lblTitle |
Control title.
| |
mAllowDesignModeActions |
If true, placeholder allows the design mode actions.
| |
mCMSEditableControls |
ArrayList of the editable controls located under current placeholder.
| |
mDesignEnabled |
If true, placeholder is enabled in design mode.
| |
mChildPagePlaceholders |
Child page placeholders.
| |
mIsAuthorized |
Indicates whether user is authorized to read the content when in live site mode.
| |
mLayoutInfo |
Placeholder level layout info.
| |
mNoLayoutPlaceholder |
Placeholder to supply window to the next page level when layout not defined.
| |
mPageLayout |
Parent page layout.
| |
mPageLevel |
Page level of the Placeholder.
| |
mPagePlaceholder |
Parent page placeholder.
| |
mPageTemplateInfo |
Placeholder level page template layout info.
| |
mPortalManager |
Parent portal manager.
| |
mSiblingPagePlaceholders |
Sibling page placeholders.
| |
mViewMode |
If set, the placeholder has overridden ViewMode.
| |
pnlDesignContent |
Design mode content container.
| |
pnlDesignHeader |
Design mode header container.
| |
pnlPlaceholder |
Overall container.
|
Properties
Name | Description | |
---|---|---|
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) | |
AllowDesignModeActions |
If true, placeholder allows the design mode actions.
| |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) | |
BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) | |
CacheMinutes |
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
| |
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) | |
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) | |
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) | |
CMSEditableControls |
Returns the array of the editable controls.
| |
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) | |
Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) | |
CssClass |
CSS class for the envelope
| |
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) | |
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.) | |
DesignEnabled |
If true, placeholder is enabled in design mode.
| |
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) | |
DisplayHeader |
If true, the page placeholder displays header in design mode
| |
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from PlaceHolder.) | |
EnableViewState | 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 Control.) | |
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) | |
HasExternalContent |
If true, placeholder is using external content (does not load the layout if available and uses the page info if set).
| |
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) | |
HidePageTemplateName |
If true, the placeholder hides the page template name
| |
CheckPermissions |
If true, placeholder checks access permissions for the editable web parts content.
| |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ChildPagePlaceholders |
Returns the table of all the inner placeholders.
| |
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
IsAuthorized |
Returns true if the user is authorized for the document.
| |
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from CMSPlaceHolder.) | |
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) | |
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) | |
Layout |
Returns the layout control.
| |
LayoutInfo |
Returns the layout information.
| |
LayoutTemplate |
Layout template, if set, the given layout is used.
| |
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) | |
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.) | |
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) | |
PageInfo |
Page info.
| |
PageLevel |
Page level.
| |
PagePlaceholder |
Parent page placeholder.
| |
PagePlaceholderID |
Page placeholder ID
| |
PageTemplateInfo |
Returns the page template information.
| |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) | |
PortalManager |
Parent portal manager.
| |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
Root |
If true, the placeholder is the main (root) placeholder on the page.
| |
ShortID |
Short ID of the control.
(Inherited from CMSPlaceHolder.) | |
SiblingPagePlaceholders |
Returns the table of all the sibling page placeholders (page placeholders on the same level).
| |
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) | |
SiteName |
Site code name.
| |
SkinID | Gets or sets the skin to apply to the control. (Inherited from Control.) | |
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) | |
TemplateInstance |
Returns page template instance structure.
| |
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) | |
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) | |
UsingDefaultDocument |
If true, placeholder is using default document.
| |
UsingDefaultPage |
Indicates whether the placeholder is using either default document or default page template.
| |
UsingDefaultPageTemplate |
If true, placeholder is using default page template.
| |
ViewMode |
Page mode of the current placeholder page.
| |
ViewState | 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 Control.) | |
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) | |
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) | |
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) | |
WebPartZones |
Web part zones collection.
|
Events
Name | Description | |
---|---|---|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) | |
Disposed | 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 Control.) | |
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) | |
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) | |
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
See Also