DbAttributeListFormat overview
Public Instance Constructors
DbAttributeListFormat
|
Overloaded. Initializes a new instance of the DbAttributeListFormat class. |
Public Instance Properties
 AttributeFormat | Gets or sets the attribute format to be used for each individual attribute |
| BreakCount | Gets or sets the number of attributes to be output before the BreakText is inserted. This allows, for example, a number of attributes to be output on the same line, or a blank line to be inserted after every 'n' attributes to aid readability. Note that the counter is reset by a SplitField. A value of 0 indicates that no such breaks are required. |
| BreakText | Gets or sets the text to be output after ever BreakCount lines within a section, e.g. a new line (if putting several attributes on the same line) or an additional new line (if adding a blank line after every 'n' attributes). This is not used if BreakCount is set to 0 (the default). |
| IncludeSplitFieldName | Gets or sets whether or not the new value of the SplitField will be output whenever this changes between one attribute and the next. This is not used if the SplitField has not been set. If true, the new value of the field is output between the 'TextBeforeSplitFieldName' and 'TextAfterSplitFieldName' |
| SplitField | Gets or sets a field to use as the split value; whenever the value of this field changes between one attribute and the next, the 'TextBeforeSplitFieldName', the new value of the field (optional), and the 'TextAfterSplitFieldName' are inserted into the output |
| TextAfterAttribute | Gets or sets the text to be inserted after each individual attribute (e.g. a new line character) |
| TextAfterSplitFieldName | Gets or sets the text to be inserted after the field name whenever the value of the specified field changes between one attribute and the next. This is not used if the SplitField has not been set. Note that this text is still output even if 'IncludeSplitFieldName' is false so that the actual split field value itself is not. |
| TextAtEnd | Gets or sets the text to be output after the final attribute in the list |
| TextAtStart | Gets or sets the text to be inserted at the start of the formatted output (e.g. a header) |
| TextBeforeAttribute | Gets or sets the text to be inserted before each individual attribute |
| TextBeforeSplitFieldName | Gets or sets the text to be inserted before the field name whenever the value of the specified field changes between one attribute and the next. This is not used if the SplitField has not been set. Note that this text is still output even if 'IncludeSplitFieldName' is false so that the actual split field value itself is not. |
Public Instance Methods
| Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object. |
| Format | Formats a DbAttributeList in the style specified |
| GetHashCode (inherited from Object) | Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. |
| GetType (inherited from Object) | Gets the Type of the current instance. |
| ToString (inherited from Object) | Returns a String that represents the current Object. |
See Also
DbAttributeListFormat Class | Aveva.Pdms.Database Namespace