This documentation is archived and is not being maintained.

StringFormat Class

Encapsulates text layout information (such as alignment, orientation and tab stops) display manipulations (such as ellipsis insertion and national digit substitution) and OpenType features. This class cannot be inherited.

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public sealed class StringFormat : MarshalByRefObject, 
	ICloneable, IDisposable

The StringFormat type exposes the following members.

Public methodStringFormat()Initializes a new StringFormat object.
Public methodStringFormat(StringFormat)Initializes a new StringFormat object from the specified existing StringFormat object.
Public methodStringFormat(StringFormatFlags)Initializes a new StringFormat object with the specified StringFormatFlags enumeration.
Public methodStringFormat(StringFormatFlags, Int32)Initializes a new StringFormat object with the specified StringFormatFlags enumeration and language.

Public propertyAlignmentGets or sets horizontal alignment of the string..
Public propertyDigitSubstitutionLanguageGets the language that is used when local digits are substituted for western digits.
Public propertyDigitSubstitutionMethodGets the method to be used for digit substitution.
Public propertyFormatFlagsGets or sets a StringFormatFlags enumeration that contains formatting information.
Public propertyStatic memberGenericDefaultGets a generic default StringFormat object.
Public propertyStatic memberGenericTypographicGets a generic typographic StringFormat object.
Public propertyHotkeyPrefixGets or sets the HotkeyPrefix object for this StringFormat object.
Public propertyLineAlignmentGets or sets the vertical alignment of the string.
Public propertyTrimmingGets or sets the StringTrimming enumeration for this StringFormat object.

Public methodCloneCreates an exact copy of this StringFormat object.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDisposeReleases all resources used by this StringFormat object.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTabStopsGets the tab stops for this StringFormat object.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodSetDigitSubstitutionSpecifies the language and method to be used when local digits are substituted for western digits.
Public methodSetMeasurableCharacterRangesSpecifies an array of CharacterRange structures that represent the ranges of characters measured by a call to the MeasureCharacterRanges method.
Public methodSetTabStopsSets tab stops for this StringFormat object.
Public methodToStringConverts this StringFormat object to a human-readable string. (Overrides Object.ToString().)

Many common formats are provided through the StringFormatFlags enumeration. StringFormat objects can be changed.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.