| CMSAbstractWebPart Methods |
The CMSAbstractWebPart type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) |
| AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) |
| AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) |
| AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) |
| AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) |
| AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) |
| ClearCache |
Causes clearing the control data cache, override to implement the data reloading procedure.
|
 | CreateChildControls |
Creates child controls within the web part.
(Overrides ControlCreateChildControls.) |
| EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) |
| EnsureVariants |
Ensures the web part variants
|
| Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) |
| Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) |
| EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) |
| EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) |
| EvalDouble |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) |
| EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) |
| EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) |
| EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) |
| EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) |
| EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) |
| EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) |
| EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) |
| ExecuteForAllNested |
Executes the given action for all nested web parts
|
| GetBothResizerScript |
Gets the script for horizontal resizer.
|
| GetCacheDependency |
Gets the cache dependency for the control.
|
| GetContainerId |
Gets the ID of the container encapsulating the web part
|
| GetDefaultCacheDependendencies |
Gets the default cache dependencies for the data source.
|
| GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) |
| GetHorizontalResizerScript |
Gets the script for horizontal resizer.
|
| GetIdentifier |
Gets web part identifier.
|
| GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) |
| GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) |
| GetString |
Returns localized string.
(Inherited from AbstractUserControl.) |
| GetStringValue |
Gets the string value of the web part
|
| GetValue |
Returns the value of the given web part property property.
|
| GetVariantID |
Gets the variant ID for rendering
|
| GetVerticalResizerScript |
Gets the script for vertical resizer.
|
| GetWireframeText |
Ensures that the given text is not empty
|
| LoadContent |
Load the content to the web part.
|
| LoadStep |
Loads the step.
|
| LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) |
| LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) |
| LogEval |
Logs the evaluation of the given column to the debug
|
| OnContentLoaded |
Method that is called when the page content is loaded, override to implement the control initialization after the content has been loaded.
|
| OnInit |
Init event handler.
(Overrides AbstractUserControlOnInit(EventArgs).) |
| OnLoad |
Load event handler.
(Overrides AbstractUserControlOnLoad(EventArgs).) |
| OnPreRender |
PreRender event handler.
(Overrides AbstractUserControlOnPreRender(EventArgs).) |
| ReleaseContext |
Releases the web part context.
|
| ReloadData |
Causes reloading the data, override to implement the data reloading procedure.
|
| RemoveVariantFromCache |
Removes the variant from cache.
|
| Render |
Renders the control.
(Overrides AbstractUserControlRender(HtmlTextWriter).) |
| ResolveMacros |
Resolves the macros within current WebPart context.
|
| ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) |
| SaveStepData |
Saves the wizard step data.
|
| SetContext |
Sets the web part context.
|
| SetValue |
Sets the property value of the control, setting the value affects only local property value.
|
| ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) |
| ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
| ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) |
| ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
| ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
| ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
| ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) |
| StepFinished |
Allows you to execute additional logic after finish/save step event.
|
| StepLoaded |
Allows you to execute additional logic after load step event.
|
| ValidateStepData |
Validates the wizard step data.
|
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.) |
| CheckRequiredColumns |
Returns true if given list of columns do not have null values in the object
(Defined by DataExtensions.) |
| ReportException |
Reports the exception within the control hierarchy by placing an exception report next to the given control.
(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.) |
See Also