The following tables list the members exposed by StringField.
| Name | Description | |
|---|---|---|
![]() | StringField Constructor | Overloaded. StringField It is default constructor for StringField. It offers no functionality but it calls the baseField's default constructor. |
| Name | Description | |
|---|---|---|
![]() | _operator | _operator _operator has been marked as protected just to allow the inheriting classes the ability to change the operator without going through the property set method, which will reset the UseInSearch flag. Or |
| Name | Description | |
|---|---|---|
![]() | AllowGroupBy | AllowGroupBy
Holds a Boolean value that can be used for specifying weather this field can be used in grouped result set or not. (Inherited from BaseField) |
![]() | AllowNull | AllowNull Holds a Boolean value that can be used for specifying weather this field can contain Null values. (Inherited from BaseField) |
![]() | AllowSave | AllowSave Holds a Boolean value that can be used for specifying weather this field can be used in updates/inserts or not. This value doesn't necessarily indicate that the field will be used in the updates/inserts, but if this is true, only then the field's UseInSave property will be used. This can be useful to the User Interface controls to be able to decide if this field will allow updates or not. (Inherited from BaseField) |
![]() | AllowSearch | AllowSearch Holds a Boolean value that can be used for specifying weather this field can be used in searching resultset or not. This value doesn't necessarily indicate that the field will be used in the Search criteria, but if this is true, only then the field's UseInSearch property will be used. This can be useful to the User Interface controls to be able to decide if this field will allow search or not. (Inherited from BaseField) |
![]() | AllowSort | AllowSort Holds a Boolean value that can be used for specifying weather this field can contain Null values. This value doesn't necessarily indicate that the field will be used in the sort, but if this is true, only then the field's Sort property will be used. This can be useful to the User Interface controls to be able to decide if this field will allow sorting or not. (Inherited from BaseField) |
![]() | BusinessObject | BusinessObject Holds a reference to the business object that contains this field. (Inherited from BaseField) |
![]() | CaseConversion | CaseConversion It holds a Boolean value. Value indicates weather this field's value's case should be modified or not. |
![]() | DBType | DBType Returns a Type representation of the .NET type that is equivalent to the underlying database type. (Inherited from BaseField) |
![]() | GetValueOrBlank | GetValueOrBlank If the IsNull property is set to true then a empty String is return else the Value is returned. |
![]() | GroupPosition | GroupPosition GroupPosition can be used to specify the position of the column in the group by clause. (Inherited from BaseField) |
![]() | GroupType | GroupType Determines weather a field will be used in group by clause and the aggregate function to use (if any). (Inherited from BaseField) |
![]() | IsCustom | IsCustom Holds a Boolean value that can be used for specifying weather this field's name is a custom name or not. If it is set to true the Name property can be assigned any valid sql String. This can be very useful for creating calculated columns in result sets where the calculated column is created by the database server. |
![]() | IsDirty | IsDirty Holds a Boolean value that can be used for checking if the value of this field has been modified since the business object values were loaded last. (Inherited from BaseField) |
![]() | IsLargeText |
IsLargeText property is used to track if the underlying database field is large text field.
Examples of such fields:
SQL Server - TEXT and NTEXT Oracle - CLOB |
![]() | IsNull | IsNull Holds a Boolean value that can be used for specifying weather this field's current value is Null or not. When IsNull is set to True the Value is destroyed. (Inherited from BaseField) |
![]() | IsValid | Returns a Boolean value indicating the status of all the validators applied to this field. (Inherited from BaseField) |
![]() | List | List List can be used to specify a list of values that are to be used in the search criteria. This is only used if the SearchMode is set to List or All. (Inherited from BaseField) |
![]() | MaximumLength | MaximumLength Holds an Int32 value that indicates the maximum length String value this StringField can hold. Value of zero means that the String has to be an empty value. Value of -1 indicates that there is no length restriction and hence the system default maximum is applied. |
![]() | MinimumLength | MinimumLength Holds an Int32 value that indicates the minimum length String value this StringField can hold. Value of zero means that the String can to be an empty value. Value of -1 indicates that there is no length restriction and hence the system default maximum is applied. NOTE: This property is not enforced during value assignment, and it is only enforced by the BaseFieldValidator. |
![]() | Name | Name Holds this field's actual column name from the database. (Inherited from BaseField) |
![]() | Operator | Operator Holds a String value that can be used for specifying search operator. Changing the Operator value also set ths UseInSearch property to true. NOTE: Starting version 3.x you can use Operators class that provides constants for each operator that is implemented. OR OR |
![]() | OriginalValue | OriginalValue is used to keep track of the original value loaded from the database during Load operation. This value is used for concurrency checking during an Update or Delete method. (Inherited from BaseField) |
![]() | PartialTextMatch | PartialTextMatch Holds a Boolean value that indicates weather this value will be used to match the text partially in a search. |
![]() | PartialTextMode | PartialTextMode It holds a PartialTextModes enum value. Value indicates weather this field's value's will be matched with records that have their field values either starting with, ending with or contain the specified value. |
![]() | ResultSetName | ResultSetName Holds a String value that can be used for specifying the result set name (i.e. an alias) for this column. (Inherited from BaseField) |
![]() | SearchCondition | SearchCondition Holds a String value that can be used for specifying search condition. You can use MoreResults property of the business object and that will automatically assign a value to the SearchCondition property. However, by directly changing the value of this property you gain full control over the search critiria. OR |
![]() | SearchMode | SearchMode SearchMode is used to determine weather the field's where clause will be based on the value, list or all. (Inherited from BaseField) |
![]() | SearchPostfix | SearchPostfix Holds a String value that can be used as postfix to the search criteria for this field. |
![]() | SearchPrefix | SearchPrefix Holds a String value that can be used as prefix to the search criteria for this field. |
![]() | Sort | Sort Determines weather a field will be used in sort and its sort direction. (Inherited from BaseField) |
![]() | SortPosition | SortPosition SortPosition can be used to specify the position of the column in the sort order. (Inherited from BaseField) |
![]() | SqlParam | SqlParam Holds a IDataParameter value that can be used for specifying the SqlParameter Name. SqlParam is not serialized and it is also ignored by the xml serialization. In normal circumstances, there is no need to assign value to this property as it automatically handles it. (Inherited from BaseField) |
![]() | TableName | TableName Holds a String value that can be used for specifying the table name for this field. (Inherited from BaseField) |
![]() | TableResultSetName | TableResultSetName Holds a String value that can be used for specifying the table's result set name for this field. This should match with the value of the business objects ResultSetName property. In normal circumstances, there is no need to assign value to this property as it automatically handles it. (Inherited from BaseField) |
![]() | UseInSave | UseInSave Holds a Boolean value that can be used for specifying weather to include this field in specifying the update command. (Inherited from BaseField) |
![]() | UseInSearch | UseInSearch Holds a Boolean value that can be used for specifying weather to include this field in specifying the search criteria. (Inherited from BaseField) |
![]() | Validators | Collection of all the validators to be applied to this field during validation. (Inherited from BaseField) |
![]() | Value | Value It holds a String value. If the MaximumLength property value is greater than -1 then the value is trimmed to the MaximumLength |
![]() | Visible | Visible Holds a Boolean value that can be used for specifying weather to include this field in resulting dataset or not. (Inherited from BaseField) |
| Name | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | AssignValueToParam | Overloaded. Overridden. AssignValueToParam Assigns the Value of this field into the database parameter passed in. Parameters:
| ||||||||||||
![]() | Copy | Overloaded. Overridden. Copy - Copies all property values from the current instance to the passed in instance. | ||||||||||||
![]() | CopyValidators | CopyValidators - Can be used to copy all the validators for a Field instance to another Field instance. The FieldToValidate properties are automatically updated to reflect the new instance. Note: This does not provide "true" copy, it only moves the references. (Inherited from BaseField) | ||||||||||||
![]() | GetFieldType | Overridden. GetFieldType Retuns a Type representation of System.String Returns:
| ||||||||||||
![]() | GetInsertExpression | GetInsertExpression It returns the value assignment String for this field to be used in an insert statement. Parameters:
Returns:
| ||||||||||||
![]() | GetListWhereExpression | GetListWhereExpression It creates the where clause for the List field of each field. Parameters:
Returns:
| ||||||||||||
![]() | GetOriginalWhereExpression | GetWhereExpression It creates the where clause based on search settings of each field. Parameters:
Returns:
| ||||||||||||
![]() | GetResultSetName | GetResultSetName GetResultSetName compares the Name property with ResultSetName property and returns ResultSetName if it is different from Name property. Returns:
| ||||||||||||
![]() | GetSortExpression | GetSortExpression It returns a String if the Sort is set to either Ascending or Descending SortTypes value. If Sort is set to None then a blank value is returned. Returns:
| ||||||||||||
![]() | GetSqlParamName | GetSqlParamName It returns a value that represents a parameter name appropriate for the selected database type. In normal situations it is needed to call this method as all the parameter handeling is done by business objects. Parameters:
Returns:
| ||||||||||||
![]() | GetSqlParamName_Orig | Overloaded. GetSqlParamName It returns a value that represents a parameter name appropriate for the selected database type. In normal situations it is needed to call this method as all the parameter handeling is done by business objects. Parameters:
Returns:
| ||||||||||||
![]() | GetUpdateExpression | GetUpdateExpression It returns the value assignment String for this field. Parameters:
Returns:
| ||||||||||||
![]() | GetValueExpression | Overridden. GetValueExpression It returns the value assignment String for this field. If the IsNull is set to true then "NULL" String value is returned otherwise Value's String representation is returned. Returns:
| ||||||||||||
![]() | GetWhereExpression | Overloaded. GetWhereExpression It creates the where clause based on search settings of each field. Parameters:
Returns:
| ||||||||||||
![]() | Parse | Overridden. Parse It will take the String parameter value and String value will be parsed from the strValue. Parameters:
| ||||||||||||
![]() | SetSqlParamType | Overridden. SetSqlParamType Sets the DbType property of the database parameter with DbType.String. Parameters:
| ||||||||||||
![]() | ToString | Overridden. ToString Returns the String version of Value. Returns:
| ||||||||||||
![]() | Validate | Validates all the validators applied to this field, and returns false if any of the validators fail. (Inherited from BaseField) |
Implicit Type Conversion | Overloaded. String This allows the developer to directly get the value of this field as String. Parameters:
|



