CreateControlArgs Class |
When determining what CellTypes and/or WebControl to use, the extension should heed the CreationFlags which provide the context for the control's use and, if a control is created by the extension, set that controls's value to the value provided by Value, if any.
See also FieldCreateControl(IField, CreateControlArgs).Namespace: NetQuarry.Data
The CreateControlArgs type exposes the following members.
Name | Description | |
---|---|---|
CreateControlArgs |
Complete constructor.
|
Name | Description | |
---|---|---|
BaseControl |
Set this to provide a WebControl instantiated by the extension. However, unless a custom
control is needed, it is better to just set the CellType via SetCellType(CellTypes, Int32)
so that the field can apply normal control configuration for the desired CellTypes.
| |
BulkContext |
Gets/sets the context of the current bulk operation, if any.
If this event is part of a bulk operation, this is the context of that bulk operation.
If this event is not part of a bulk operation, this context will be null.
(Inherited from EAPEventArgs.) | |
CellType |
Initially this is the CellType value of the associated IField.
To set this value use SetCellType(CellTypes, Int32) which requires that both the CellType
and CellTypeAttributes be set together. The extension can set the CellType
and not the BaseControl to have the field object create the control using its normal
control creation logic for that CellTypes.
| |
CellTypeAttributes |
Initially this is the CellTypeAttributes value of the associated IField.
To set this value use SetCellType(CellTypes, Int32) which requires that both the CellType
and CellTypeAttributes be set together.
| |
CreationFlags |
These ControlCreationFlags flags specify details about how the control to be created is to be used or presented.
For example, ForListEdit specifies that the control is to be used in an editable list.
| |
ErrorDeveloperMessage |
An optional, developer-specific error message. This will be logged to the Devlog and xot_request_log, but
only displayed in user error messages when the user is identified as IsDeveloper.
(Inherited from EAPEventArgs.) | |
ErrorMessage |
Sets the extention's error message for this event.
(Inherited from EAPEventArgs.) | |
ErrorOptions |
Options used to specify additional characteristics about an exception.
(Inherited from EAPEventArgs.) | |
Event |
Gets/Sets the event that is currently executing.
(Inherited from EAPEventArgs.) | |
ID |
The ID that will be used for the WebControl's ID value. This ID will
be used unless a BaseControl is provided with its ID set to another value.
| |
Result |
Gets/Sets the result to return from the event.
(Inherited from EAPEventArgs.) | |
Value |
The initial control value as provided during control creation.
|
Name | Description | |
---|---|---|
Cancel |
Sets the extention's result code and error message for this event. The result code
is set to ExtResultsExtResults.Cancel.
(Inherited from EAPEventArgs.) | |
Equals | (Inherited from Object.) | |
Error(String) |
Sets the extention's result code and error message for this event.
The result code is set to Error.
Use Error(String, String, ExceptionOptions) to include an additional developer message and/or options.
(Inherited from EAPEventArgs.) | |
Error(String, String, ExceptionOptions) |
Sets the extention's result code and error message for this event with an optional developer-specific
error message and options.
The result code is set to Error.
(Inherited from EAPEventArgs.) | |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
SetCellType |
The extension will typically call this method to support dynamic control types. This method must
be used instead of setting CellType and CellTypeAttributes separately because
CellTypeAttributes are interpreted entirely differently depending on the
CellType setting making it treacherous to change the CellType
without ensuring that the CellTypeAttributes is set accordingly. When the
CellType is set, but not the BaseControl, the field object will perform
normal control creation and configuration for the specified CellTypes. Generally this
is the preferred method for implementing dynamic (per-record) control handling and setting
BaseControl should be avoided unless a non-standard control or configuration is required.
| |
ToString | (Inherited from Object.) |
Name | Description | |
---|---|---|
EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |