DataFormatterBase Class

TIBCO Spotfire 7.9 API Reference

Abstract base class for formatters. Handles read-only state, cloning and formatting of invalid values.

Inheritance Hierarchy

Namespace: Spotfire.Dxp.Data.Formatters
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 30.0.10915.3380 (30.0.10915.3380)

Syntax

[SerializableAttribute]
[PersistenceVersionAttribute(10, 10)]
public abstract class DataFormatterBase : IDataFormatter, 
	ICloneable, ISerializable

The DataFormatterBase type exposes the following members.

Constructors

	Name	Description
	DataFormatterBase	Initializes a new instance of the DataFormatterBase class.

Methods

	Name	Description
	AsReadOnly	Returns the given formatter if already read-only, otherwise a read-only copy.
	CheckReadOnly	Throws InvalidOperationException if the formatter is read-only. Do this check before setting a property.
	Clone	Returns a writable copy of this formatter.
	Equals	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(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	Override this method to convert an object to a string value.
	FormatInvalid	Formats an invalid value. If error is not null, the return value includes the "(error)" string, otherwise EmptyString is returned.
	GetHashCode	Gets a hash code for the current Object. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Parse	Override this method to convert a string value to an object.
	TryParse	Converts a string representation to an object. A return value indicates whether the conversion succeeded or failed.

Properties

	Name	Description
	CultureInfo	Gets or sets a CultureInfo object that defines the default formatting.
	EmptyString	Gets or sets the string used to indicate empty values. (FormatInvalid(String)).
	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.
	IsLocalized	Gets a value indicating whether this formatter is localized and always uses CultureInfo derived from the current running thread or not.
	IsReadOnly	Gets a value indicating whether the formatter is read-only or not.

Version Information