Nintex.Forms.Sdk Reference
NintexFormControl Members
The following tables list the members exposed by the NintexFormControl type.
Name | Description | |
---|---|---|
![]() |
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (inherited from WebControl). |
![]() |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (inherited from Control). |
![]() |
AssociatedControlForLabel | (inherited from BaseFormControl). Gets the associated control for label. |
![]() |
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). |
![]() |
BindingParent | (inherited from BaseFormControl). |
![]() |
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). |
![]() |
CanActAsDefaultControlForColumn | (inherited from BaseFormControl). Gets or sets a value indicating whether this instance can act as default control for column. |
![]() |
CanResizeHeight | (inherited from BaseFormControl). Gets or sets a value indicating whether this instance can resize height. |
![]() |
CanResizeWidth | (inherited from BaseFormControl). Gets or sets a value indicating whether this instance can resize width. |
![]() |
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). |
![]() |
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). |
![]() |
Controls | Gets a ControlCollection object that represents the child controls in a CompositeControl. (inherited from CompositeControl). |
![]() |
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (inherited from WebControl). |
![]() |
CustomZIndex | (inherited from BaseFormControl). Gets or sets the custom Z-Index. |
![]() |
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). |
![]() |
DefaultCanResizeAtRuntime | (inherited from BaseFormControl). Gets or sets a value indicating whether [default can resize at runtime]. |
![]() |
DefaultGridHeight | (inherited from BaseFormControl). Gets or sets the default height of the grid. |
![]() |
DefaultGridWidth | (inherited from BaseFormControl). Gets or sets the default width of the grid. |
![]() |
DefaultInsertMode | (inherited from BaseFormControl). Gets or sets a value indicating whether the control is the default when in insert mode. If multiple are selected then the lowest sequence number is used. |
![]() |
Description | (inherited from BaseFormControl). Gets or sets the description. |
![]() |
DesignTimeCssUrl | (inherited from BaseFormControl). Gets or sets the design time CSS URL. |
![]() ![]() |
DisabledCssClass | Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled. (inherited from WebControl). |
![]() |
DisplayName | (inherited from BaseFormControl). Gets or sets the display name. |
![]() |
DisplayNameSuffix | (inherited from BaseFormControl). Gets or sets the display name suffix. |
![]() |
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). |
![]() |
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (inherited from WebControl). |
![]() |
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). |
![]() |
FormControlLayout | (inherited from BaseFormControl). Gets or sets the form control layout. |
![]() |
FormControlProperties | (inherited from BaseFormControl). Gets or sets the form properties. |
![]() |
FormControlTypeUniqueId | (inherited from BaseFormControl). Gets the items unique id. |
![]() |
FormFiller | (inherited from BaseFormControl). Gets the form filler. |
![]() |
GroupName | (inherited from BaseFormControl). Gets or sets the name of the group. |
![]() |
GroupOrder | (inherited from BaseFormControl). Gets or sets the group order. |
![]() |
HasAttributes | Gets a value indicating whether the control has attributes set. (inherited from WebControl). |
![]() |
HasClientValue | (inherited from BaseFormControl). |
![]() |
Height | Gets or sets the height of the Web server control. (inherited from WebControl). |
![]() |
HelpKey | (inherited from BaseFormControl). |
![]() |
ID | Gets or sets the programmatic identifier assigned to the server control. (inherited from Control). |
![]() |
IsAvailableInEnvironment | (inherited from BaseFormControl). Gets a value indicating whether this instance is available in environment. |
![]() |
IsBindableContainer | (inherited from BaseFormControl). Gets or sets a value indicating whether this instance is a container control that could be data bound. |
![]() |
IsContainer | (inherited from BaseFormControl). Gets or sets a value indicating whether this instance is a container control. |
![]() |
IsRepeatable | (inherited from BaseFormControl). Gets or sets a value indicating whether this instance is a control that can be added to a repeating section. |
![]() |
MinGridHeight | (inherited from BaseFormControl). |
![]() |
MinGridWidth | (inherited from BaseFormControl). |
![]() |
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). |
![]() |
OriginalValue | (inherited from BaseBindableFormControl). |
![]() |
OriginalValueIsNull | (inherited from BaseBindableFormControl). |
![]() |
OriginalValueSet | (inherited from BaseBindableFormControl). |
![]() |
OverflowHidden | (inherited from BaseFormControl). |
![]() |
Page | Gets a reference to the Page instance that contains the server control. (inherited from Control). |
![]() |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (inherited from Control). |
![]() |
ParentFormView | (inherited from BaseFormControl). Gets the parent form view. |
![]() |
ReadOnly | (inherited from BaseFormControl). Gets a value indicating whether read only. |
![]() |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (inherited from Control). |
![]() |
ReplacementControl | (inherited from BaseFormControl). Gets or sets the control to be used if this control is not found. |
![]() |
Sequence | (inherited from BaseFormControl). Gets or sets the sequence. |
![]() |
ShowInToolBox | (inherited from BaseFormControl). Gets or sets a value indicating whether the control shows in the toolbox General tab. |
![]() |
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). |
![]() |
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). |
![]() |
SupportedFormControlTypes | (inherited from BaseFormControl). Gets or sets the type of the supported workflow initiation control. |
![]() |
SupportedValueTypes | (inherited from BaseFormControl). Gets or sets the supported value types. |
![]() |
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 CompositeControl). |
![]() |
TabIndex | Gets or sets the tab index of the Web server control. (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). |
![]() |
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (inherited from WebControl). |
![]() |
ToolboxIcon | (inherited from BaseFormControl). Gets the toolbox icon. |
![]() |
ToolboxIconUrl | (inherited from BaseFormControl). Gets or sets the toolbox icon URL. |
![]() |
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (inherited from Control). |
![]() |
UnsupportedFormTypes | (inherited from BaseFormControl). Gets or sets the unsupported form types. |
![]() |
ValidateRequestMode | Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (inherited from Control). |
![]() |
Value | (inherited from BaseBindableFormControl). Gets the value. |
![]() |
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). |
![]() |
Width | Gets or sets the width of the Web server control. (inherited from WebControl). |
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). |
![]() |
AddCommonPropertiesToControl | (Overloaded) (inherited from BaseFormControl). dds the common properties to 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). |
![]() |
AddValueToDictionary | (inherited from BaseFormControl). Adds the value to dictionary. |
![]() |
AddedControl | Called after a child control is added to the Controls collection of the Control object. (inherited from Control). |
![]() |
ApplyCommonValidatorSettings | (inherited from BaseFormControl). Applies the common validator settings. |
![]() |
ApplyDefaultFormProperties | (inherited from BaseFormControl). Applies the default form properties based on the provided form variable. |
![]() |
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). |
![]() ![]() |
ApplyStyles | (inherited from BaseFormControl). Applies the styles. |
![]() |
BeginRenderTracing | Begins design-time tracing of rendering data. (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). |
![]() |
ClearCachedClientID | Sets the cached ClientID value to null. (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). |
![]() |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (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). |
![]() |
CreateChildControls | (inherited from BaseBindableFormControl). |
![]() |
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). |
![]() |
CreateFormControls | (inherited from BaseFormControl). 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. |
![]() |
CreateRequiredFieldValidation | (inherited from BaseBindableFormControl). |
![]() |
CreateValidationControls | (inherited from BaseBindableFormControl). Creates the validation controls. |
![]() |
CreateValidationControlsForRules | (inherited from BaseFormControl). |
![]() |
DataBind | (Overloaded) Binds a data source to the CompositeControl and all its child controls. (inherited from CompositeControl). |
![]() |
DataBindChildren | Binds a data source to the server control's child controls. (inherited from Control). |
![]() ![]() |
DisableControls | (inherited from BaseFormControl). Disables the controls. |
![]() |
Dispose | Enables a server control to perform final clean up before it is released from memory. (inherited from Control). |
![]() |
EndRenderTracing | Ends design-time tracing of rendering data. (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 | (Overloaded) Determines whether the specified object is equal to the current object. (inherited from Object). |
![]() |
ExtractValues | (inherited from BaseBindableFormControl). Retrieves a set of name/value pairs to implement two-way data-binding in field template controls. |
![]() |
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 | (Overloaded) Searches the current naming container for a server control with the specified id parameter. (inherited from Control). |
![]() |
Focus | Sets input focus to a control. (inherited from Control). |
![]() |
ForceExtractValues | (inherited from BaseBindableFormControl). Retrieves a set of name/value pairs to implement two-way data-binding in field template controls. |
![]() |
FormatDataValue | (Overloaded) (inherited from BaseBindableFormControl). Formats the data value. |
![]() |
GetCanvasDesignTimeHtml | (inherited from BaseFormControl). Here you can add the Script to the page as well. |
![]() |
GetCanvasDesignTimeHtmlWrapperStyles | (inherited from BaseFormControl). Gets the canvas design time HTML wrapper styles. |
![]() |
GetDefaultFormProperties | (Overloaded) (inherited from BaseFormControl. Gets the default form properties. |
![]() |
GetDefaultFormPropertiesProtected | (Overloaded) (inherited from BaseFormControl). Gets the default form properties. |
![]() |
GetDesignModeState | Gets design-time data for a control. (inherited from Control). |
![]() |
GetHashCode | Serves as the default hash function. (inherited from Object). |
![]() |
GetImageFromAssembly | (inherited from BaseFormControl). Gets the image from assembly. |
![]() |
GetRouteUrl | (Overloaded) Gets the URL that corresponds to a set of route parameters. (inherited from Control). |
![]() |
GetRulesCustomValidator | (inherited from BaseFormControl). Applies the common rules validator settings. |
![]() |
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). |
![]() |
GetUpdatedValue | (inherited from BaseBindableFormControl). Gets the updated value. |
![]() |
GetValue | (Overloaded) (inherited from BaseBindableFormControl). Gets the value. |
![]() |
HandleException | (inherited from BaseFormControl). |
![]() |
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). |
![]() |
Initialise | (inherited from BaseFormControl). |
![]() |
IsLiteralContent | Determines if the server control holds only literal content. (inherited from Control). |
![]() |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (inherited from Control). |
![]() |
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState method. (inherited from WebControl). |
![]() |
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). |
![]() |
OnDataBinding | Raises the DataBinding event. (inherited from Control). |
![]() |
OnFormControlDataBinding | (inherited from BaseFormControl). Called when the form control is data binding. |
![]() |
OnInit | Raises the Init event. (inherited from Control). |
![]() |
OnLoad | (inherited from BaseFormControl). Raises the Load event. |
![]() |
OnPreRender | (inherited from BaseBindableFormControl). Raises the OnPreRender event. |
![]() |
OnUnload | Raises the Unload event. (inherited from Control). |
![]() |
OpenFile | Gets a Stream used to read a file. (inherited from Control). |
![]() |
ProcessDesignerPageInit | (inherited from BaseFormControl). Processes the designer page init. This is where things like the ribbon and scripts are setup. |
![]() |
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (inherited from Control). |
![]() |
RecreateChildControls | Recreates the child controls in a control derived from CompositeControl. (inherited from CompositeControl). |
![]() ![]() |
ReferenceEquals | Determines whether the specified Object instances are the same instance. (inherited from Object). |
![]() |
RegisterCustomValidationAttributes | (inherited from BaseBindableFormControl). On a validation error if an ID is specified for controltohighlightonerror then that will be highlighted if its empty then it will fallback to the first parent of the control that has a special class 'nf-filler-highlightonvalidationerror' if only controltovalidateforrequiredval is specified then it will be used as both controltovalidate and control to highlight if none of the above are specified by a control then the default behavior of using the associatedcontrolforlabel will be used these attributes will be used to perform custom validations on certain controls where we cannot associate controltovalidate on the validators, e.g boolean, choice Derived classes should register attributes for any validations they want to perform, e.g custom, required or rules validation. |
![]() |
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (inherited from Control). |
![]() |
Render | Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client. (inherited from CompositeControl). |
![]() |
RenderBeginTag | (inherited from BaseFormControl). Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. |
![]() |
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). |
![]() |
RenderContents | Renders the contents of the control to the specified writer. This method is used primarily by control developers. (inherited from WebControl). |
![]() |
RenderControl | (Overloaded) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (inherited from Control). |
![]() ![]() |
RenderControlToString | (Overloaded) (inherited from BaseFormControl). Renders the control to string. |
![]() |
RenderEndTag | (inherited from BaseFormControl). Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. |
![]() |
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). |
![]() |
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). |
![]() |
SetTraceData | (Overloaded) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (inherited from Control). |
![]() |
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). |
![]() |
ValidForDisplay | (inherited from BaseFormControl). |
Name | Description | |
---|---|---|
![]() |
CanParseTo | (Overloaded) (Defined by ObjectExtensions). |
![]() |
FindAllControls | (Overloaded) (Defined by NfUtilities). |
![]() |
FindParentControl | (Defined by NfUtilities). |
![]() |
FindParentControls | (Defined by NfUtilities). |
![]() |
HideControl | (Defined by NfUtilities). |
![]() |
RecursiveControlFinder | (Overloaded) (Defined by NfUtilities). |
![]() |
TryParse | (Overloaded) (Defined by ObjectExtensions). |
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). |