This topic has not yet been rated - Rate this topic

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.

System.Object
  System.MarshalByRefObject
    System.Drawing.StringFormat

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)
public sealed class StringFormat : MarshalByRefObject, 
	ICloneable, IDisposable

The StringFormat type exposes the following members.

  Name Description
Public method StringFormat() Initializes a new StringFormat object.
Public method StringFormat(StringFormat) Initializes a new StringFormat object from the specified existing StringFormat object.
Public method StringFormat(StringFormatFlags) Initializes a new StringFormat object with the specified StringFormatFlags enumeration.
Public method StringFormat(StringFormatFlags, Int32) Initializes a new StringFormat object with the specified StringFormatFlags enumeration and language.
Top
  Name Description
Public property Alignment Gets or sets horizontal alignment of the string..
Public property DigitSubstitutionLanguage Gets the language that is used when local digits are substituted for western digits.
Public property DigitSubstitutionMethod Gets the method to be used for digit substitution.
Public property FormatFlags Gets or sets a StringFormatFlags enumeration that contains formatting information.
Public property Static member GenericDefault Gets a generic default StringFormat object.
Public property Static member GenericTypographic Gets a generic typographic StringFormat object.
Public property HotkeyPrefix Gets or sets the HotkeyPrefix object for this StringFormat object.
Public property LineAlignment Gets or sets the vertical alignment of the string.
Public property Trimming Gets or sets the StringTrimming enumeration for this StringFormat object.
Top
  Name Description
Public method Clone Creates an exact copy of this StringFormat object.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose Releases all resources used by this StringFormat object.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetTabStops Gets the tab stops for this StringFormat object.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method SetDigitSubstitution Specifies the language and method to be used when local digits are substituted for western digits.
Public method SetMeasurableCharacterRanges Specifies an array of CharacterRange structures that represent the ranges of characters measured by a call to the MeasureCharacterRanges method.
Public method SetTabStops Sets tab stops for this StringFormat object.
Public method ToString Converts this StringFormat object to a human-readable string. (Overrides Object.ToString().)
Top

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ