Formatter for string values.
Inheritance Hierarchy
Spotfire.Dxp.Data.FormattersDataFormatterBase
Spotfire.Dxp.Data.FormattersStringFormatter
Namespace: Spotfire.Dxp.Data.Formatters
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 69.0.21424.2902 (69.0.21424.2902)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(2, 0)] public class StringFormatter : DataFormatterBase
The StringFormatter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | StringFormatter |
Initializes a new instance of the StringFormatter class.
|
Properties
| Name | Description | |
|---|---|---|
 | CultureInfo |
Gets or sets a CultureInfo object that defines the
default formatting.
(Inherited from DataFormatterBase.) |
| CultureName |
Gets or sets the name of the culture that defines the default formatting.
(Inherited from DataFormatterBase.) |
| EmptyString |
Gets or sets the string used to indicate empty values.
(FormatInvalid(String)).
(Inherited from DataFormatterBase.) |
| ExactParse | Gets or sets a value indicating whether
the format of the string representation must match the
specified format exactly or not. Default is false.
(Inherited from DataFormatterBase.) |
| IsLocalized |
Gets a value indicating whether this formatter is localized and always
uses CultureInfo derived from the current running thread or not.
(Inherited from DataFormatterBase.) |
| IsReadOnly | Gets a value indicating whether the formatter is read-only or not.
(Inherited from DataFormatterBase.) |
| Truncate | Gets or sets a value indicating whether the formatted string is truncated or not.
|
Methods
| Name | Description | |
|---|---|---|
| CheckReadOnly |
Throws InvalidOperationException if the formatter is
read-only. Do this check before setting a property.
(Inherited from DataFormatterBase.) |
 | Clone |
Returns a writable copy of this formatter.
(Inherited from DataFormatterBase.) |
| Equals |
Determines whether the specified Object is equal to the current Object.
(Overrides DataFormatterBaseEquals(Object).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| Format |
Converts an object to a string value; no actual conversion is
performed. By default the string is truncated to 65535 characters
(Truncate).
(Overrides DataFormatterBaseFormat(Object).) |
| FormatInvalid |
Formats an invalid value. If error is not null,
the return value includes the "(error)" string, otherwise
EmptyString is returned.
(Inherited from DataFormatterBase.) |
| GetHashCode |
Gets a hash code for the current Object.
(Overrides DataFormatterBaseGetHashCode.) |
| GetObjectData |
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides DataFormatterBaseGetObjectData(SerializationInfo, StreamingContext).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Parse |
Returns the string value; no actual conversion is performed.
(Overrides DataFormatterBaseParse(String).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryParse |
Converts a string representation to an object. A return value indicates
whether the conversion succeeded or failed.
(Inherited from DataFormatterBase.) |
Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also