The CMSWebPartZone 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 | |
---|---|---|
CMSWebPartZone |
Constructor.
| |
CMSWebPartZone(Boolean) |
Constructor.
|
Methods
Name | Description | |
---|---|---|
AddAttributesToRender | Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl.) | |
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.) | |
ApplyStyle | Copies 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 WebControl.) | |
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.) | |
cachedControl_PreRender |
PreRender event handler.
| |
ClearCache |
Clears the caches of all the web parts.
| |
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.) | |
CopyBaseAttributes | Copies the properties not encapsulated by the 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 WebControl.) | |
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) | |
CreateControlStyle | Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl.) | |
CreateChildControls | 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 Control.) | |
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.) | |
EnablePartialCache |
Returns true if the partial caching is enabled.
| |
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.) | |
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).
| |
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 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.) | |
GetValue |
Returns the value of the given webpart property property.
| |
GetWebPart |
Returns web part with the specified name or null if not found.
| |
GetWebPartUrl |
Gets the URL for the web part to load.
| |
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.) | |
LoadCachedWebPart |
Loads the content to the partially cached web part
| |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) | |
LoadRegionsContent |
Loads the editable regions content.
| |
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (Inherited from WebControl.) | |
LoadWebPart |
Loads the web part to the given zone. Returns the newly created web part.
| |
LoadWebParts |
Loads the web parts to the control.
| |
LoadWebPartsContent |
Loads the web parts content.
| |
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.) | |
MergeStyle | Copies 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 WebControl.) | |
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) | |
OnContentLoaded |
Method that is called when the page content is fully loaded.
| |
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) | |
OnInit |
Init action.
(Overrides CMSWebControl OnInit(EventArgs).) | |
OnLoad |
Load action.
(Overrides Control OnLoad(EventArgs).) | |
OnPreRender |
PreRender action.
(Overrides Control OnPreRender(EventArgs).) | |
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.) | |
ReloadControls | Obsolete.
Reloads the zone controls.
| |
ReloadData |
Causes reloading the data, override to implement the data reloading procedure.
| |
RemovedControl | (Inherited from Control.) | |
RemoveVariantFromCache |
Removes the variant from cache.
| |
Render |
Render action.
(Overrides WebControl Render(HtmlTextWriter).) | |
RenderBeginTag | Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
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.) | |
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) | |
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 | Obsolete.
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.) | |
ResolveMacros |
Resolves the macros within current WebPart context.
| |
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 state that was modified after the TrackViewState method was invoked. (Inherited from WebControl.) | |
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.) | |
SetValue |
Sets the property value of the control, setting the value affects only local property value.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackViewState | Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl.) | |
Validate |
Saves the page content to the page info.
|
Extension Methods
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
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.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) | |
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 | |
---|---|---|
extDragDrop |
Drag and drop extender.
| |
lblTitle |
Zone title.
| |
mCMSEditableControls |
List of the editable controls located under current placeholder.
| |
mContainer |
Container info object.
| |
mContextResolver |
Zone context resolver.
| |
mLocalProperties |
Local web part properties.
| |
mNotResolveProperties |
List of the property names that should not be resolved with macros.
| |
mOrphaned |
True if the zone is orphaned - Not included in layout.
| |
mPagePlaceholder |
Parent page placeholder.
| |
mParentZoneControl |
If this instance is a zone variant then this variable contains the parent zone control (CMSWebPartZone), otherwise is null.
| |
mPnlZoneVariants |
Container for zone variants.
| |
mShortClientID |
Short client ID.
| |
mSQLProperties |
List of the property names that are used in SQL queries and should avoid SQL injection.
| |
mUpdatePanel |
Update panel.
| |
mViewMode |
Zone view mode.
| |
mWebPartContainer |
Web part container.
| |
mWebParts |
Collection of all the web part located within the zone.
| |
mWidgetZoneType |
Zone type.
| |
mZoneInstance |
Zone instance with the settings.
| |
pnlCue |
Drop cue panel.
| |
pnlDesignHeader |
Zone design mode header container.
| |
pnlZone |
Zone container.
|
Properties
Name | Description | |
---|---|---|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) | |
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) | |
AdjustFreeLayoutToParent |
If true, then the size of the free layout is adjusted to match the parent size
| |
Align |
Align
| |
AllowModifyWebPartCollection |
If true, the zone allows adding new web parts
| |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) | |
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) | |
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) | |
BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) | |
BorderColor | Gets or sets the border color of the Web control. (Inherited from WebControl.) | |
BorderStyle | Gets or sets the border style of the Web server control. (Inherited from WebControl.) | |
BorderWidth | Gets or sets the border width of the Web server control. (Inherited from WebControl.) | |
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.
| |
ConditionalLayout |
Conditional layout within which the zone is placed.
| |
Container |
Web part container object.
| |
ContainerAfter |
Container to render after the control.
| |
ContainerBefore |
Container to render before the control.
| |
ContainerClientID |
Returns the client ID of the zone container control
| |
ContainerHideOnCurrentPage |
Returns true if the container should be hidden on current page (hide container on subpages in effect).
| |
ContainerHideOnSubPages |
Hide container on sub pages.
| |
ContainerName |
Container name.
| |
ContainerTitle |
Container title.
| |
ContentAfter |
Content after.
| |
ContentBefore |
Content before.
| |
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) | |
ContextResolver |
Web part zone context resolver.
| |
Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) | |
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) | |
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) | |
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) | |
CustomTimeZone |
Returns custom time zone info.
| |
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.) | |
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) | |
DisplayHeader |
If true, the web part zone displays header in design mode
| |
DisplayToRoles |
Display to roles.
| |
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) | |
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) | |
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.) | |
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) | |
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) | |
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) | |
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) | |
HasVariants |
Indicates whether the zone has any variants.
| |
HeaderContainer |
Control to which the zone header should be rendered
| |
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) | |
HideOnCurrentPage |
Returns true if the control should be hidden on current page (hide control on subpages in effect).
| |
HideOnSubPages |
Hide on sub pages.
| |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ChildrenHaveVariants |
Returns true if the children components have any variants
| |
ID |
Gets or sets the programmatic identifier assigned to the server control.
(Overrides Control ID.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
InstanceGUID |
Web part instance GUID.
| |
IsEmpty |
Returns true if the zone is empty (no web part is visible)
| |
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) | |
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 CMSWebControl.) | |
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) | |
IsVariant |
Indicates whether this web part is a variant of an existing zone.
| |
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) | |
IsVisible |
Returns true if the web part zone is visible.
| |
LayoutType |
Zone layout type
| |
LayoutZone |
True if the zone is generated by web part layout.
| |
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) | |
Margin |
Margin
| |
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.) | |
NotResolveProperties |
List of the property names that should not be resolved with macros.
| |
Padding |
Padding
| |
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) | |
PagePlaceholder |
Parent page placeholder.
| |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) | |
ParentHasVariants |
Returns true if the parent component has any variants
| |
ParentWebPart |
Parent portal component
| |
ParentZoneControl |
Gets the parent zone control (CMSWebPartZone) if this instance is a zone variant. Otherwise returns null.
| |
PnlZoneVariants |
Container for zone variants.
| |
PortalManager |
Parent portal manager.
| |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
ShortClientID |
Returns the short client ID of the web part.
| |
ShortID |
Short ID of the control.
(Inherited from CMSWebControl.) | |
ShowForDocumentTypes |
Show for document types.
| |
SimpleRender |
If true, the zone is rendered in a simple mode
| |
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) | |
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) | |
SQLProperties |
List of the property names that are used in SQL queries and should avoid SQL injection.
| |
Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) | |
SupportsDisabledAttribute | Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is false. (Inherited from WebControl.) | |
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) | |
TagKey |
Overrides the generation of the SPAN tag with custom tag.
(Overrides WebControl TagKey.) | |
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) | |
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) | |
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) | |
TimeZoneType |
Returns time zone type.
| |
TitleLabel |
Gets the zone title label.
| |
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) | |
UIContext |
Returns control's UI context
(Inherited from CMSWebControl.) | |
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) | |
UpdatePanel |
Update panel of the web part.
| |
UseUpdatePanel |
Use update panel.
| |
ViewMode |
Page mode of the current zone.
| |
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.) | |
WebPartContainer |
Web part container control.
| |
WebPartManagementRequired |
Indicates whether the web part management support is required.
| |
WebParts |
List of WebParts contained within the zone.
| |
WidgetZoneType |
Widget zone type.
| |
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) | |
Wireframe |
If set to true, the zone is set to free layout adjusting to parent and simple rendering mode for wireframe purposes
| |
ZoneHeight |
Height of the web part zone
| |
ZoneId |
Zone Id used mainly in conditional layouts where zone should be shared in multiple layouts.
| |
ZoneInstance |
Web part zone instance object.
| |
ZoneTitle |
Zone title.
| |
ZoneType |
Gets or sets the type of the zone. This value is processed only in the UI pages.
| |
ZoneWidth |
Width of the web part zone
|
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