Formatting Class

Spotfire 14.3 API Reference

Represents formatting settings to be used when rendered. The settings can contain formatters for between 0 and 8 data types, namely Integer, Real, Currency, DateTime, LongInteger, SingleReal, TimeSpan and Boolean. In addition, for each data type a specific formatter can be set for a category or column, specified by a CategoryKey. This is referred to as "indexed".

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsFormatting

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(7, 0)]
public sealed class Formatting : DocumentNode

The Formatting type exposes the following members.

Properties

	Name	Description
	BooleanFormatter	Gets or sets the TimeSpanFormatter used for the data type TimeSpan.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	CurrencyFormatter	Gets or sets the NumberFormatter used for the data type Currency.
	DateTimeFormatter	Gets or sets the DateTimeFormatter used for the data types Date, Time and DateTime.
	IndexedBooleanFormatter	Gets the indexed BooleanFormatter used for the data type Boolean.
	IndexedCurrencyFormatter	Gets the indexed NumberFormatter used for the data type Currency.
	IndexedDateTimeFormatter	Gets the indexed DateTimeFormatter used for the data types Date, Time and DateTime.
	IndexedIntegerFormatter	Gets the indexed NumberFormatter used for the data type Integer.
	IndexedLongIntegerFormatter	Gets the indexed NumberFormatter used for the data type LongInteger.
	IndexedRealFormatter	Gets the indexed NumberFormatter used for the data type Real.
	IndexedSingleRealFormatter	Gets the indexed NumberFormatter used for the data type SingleReal.
	IndexedTimeSpanFormatter	Gets the indexed TimeSpanFormatter used for the data type TimeSpan.
	IntegerFormatter	Gets or sets the NumberFormatter used for the data type Integer.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	LongIntegerFormatter	Gets or sets the NumberFormatter used for the data type LongInteger.
	RealFormatter	Gets or sets the NumberFormatter used for the data type Real.
	SingleRealFormatter	Gets or sets the NumberFormatter used for the data type SingleReal.
	TimeSpanFormatter	Gets or sets the TimeSpanFormatter used for the data type TimeSpan.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	Clear	Clears all formatting settings for all data types, non-indexed as well as indexed.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals Namespace