Skip to main content

DXStringFormat Class

Enumerates string formatting settings.

Declaration

public class DXStringFormat extends JavaObject implements IEquatable<DXStringFormat>

Implements

com.devexpress.system.IEquatable<com.devexpress.drawing.DXStringFormat>

Inherited Members

com.devexpress.system.JavaObject.clone()
com.devexpress.system.JavaObject.equals(java.lang.Object)
com.devexpress.system.JavaObject.hashCode()
com.devexpress.system.JavaObject.initFields()
com.devexpress.system.JavaObject.memberwiseClone()
com.devexpress.system.JavaObject.toString()
java.lang.Object.finalize()
java.lang.Object.getClass()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long,int)

Inheritance

Object
com.devexpress.system.JavaObject
DXStringFormat

Constructors

DXStringFormat() Constructor

Initializes a new instance of the DXStringFormat class.

Declaration

public DXStringFormat()

DXStringFormat(DXStringFormat format) Constructor

Initializes a new instance of the DXStringFormat class with specified settings.

Declaration

public DXStringFormat(DXStringFormat format)

Parameters

Name Type Description
format DXStringFormat

The source string format.

Methods

clone() Method

Creates a copy of this string format.

Declaration

public DXStringFormat clone()

Returns

Type Description
DXStringFormat

The cloned DXStringFormat object.

createGenericDefault() Method

Creates the default generic string format.

Declaration

public static DXStringFormat createGenericDefault()

Returns

Type Description
DXStringFormat

The default generic string format.

createGenericTypographic() Method

Creates the generic typographic string format.

Declaration

public static DXStringFormat createGenericTypographic()

Returns

Type Description
DXStringFormat

The generic typographic string format.

equals(DXStringFormat other) Method

Checks whether this string format equals the specified string format.

Declaration

public boolean equals(DXStringFormat other)

Parameters

Name Type Description
other DXStringFormat

The string format to compare.

Returns

Type Description
boolean

true if this string format equals the specified string format; otherwise, false.

equals(Object obj) Method

Checks whether this string format equals the specified string format.

Declaration

public boolean equals(Object obj)

Parameters

Name Type Description
obj Object

The string format to compare.

Returns

Type Description
boolean

true if this string format equals the specified string format; otherwise, false.

getAlignment() Method

Returns the alignment.

Declaration

public DXStringAlignment getAlignment()

Returns

Type Description
DXStringAlignment

The string alignment.

getFormatFlags() Method

Returns the format flags.

Declaration

public DXStringFormatFlags getFormatFlags()

Returns

Type Description
DXStringFormatFlags

The string format flags.

getHotkeyPrefix() Method

Returns the hotkey prefix.

Declaration

public DXHotkeyPrefix getHotkeyPrefix()

Returns

Type Description
DXHotkeyPrefix

The hotkey prefix.

getLineAlignment() Method

Returns the line alignment.

Declaration

public DXStringAlignment getLineAlignment()

Returns

Type Description
DXStringAlignment

The line alignment.

getTabStops() Method

Returns the tab stops.

Declaration

public float[] getTabStops()

Returns

Type Description
float[]

The tab stops.

getTrimming() Method

Returns the trimming mode.

Declaration

public DXStringTrimming getTrimming()

Returns

Type Description
DXStringTrimming

The string trimming mode.

hashCode() Method

Returns a hash code value for this object.

Declaration

public int hashCode()

Returns

Type Description
int

The hash code.

setAlignment(DXStringAlignment value) Method

Specifies the alignment.

Declaration

public void setAlignment(DXStringAlignment value)

Parameters

Name Type Description
value DXStringAlignment

The string alignment.

setFormatFlags(DXStringFormatFlags value) Method

Specifies the format flags.

Declaration

public void setFormatFlags(DXStringFormatFlags value)

Parameters

Name Type Description
value DXStringFormatFlags

The string format flags.

setHotkeyPrefix(DXHotkeyPrefix value) Method

Specifies the hotkey prefix.

Declaration

public void setHotkeyPrefix(DXHotkeyPrefix value)

Parameters

Name Type Description
value DXHotkeyPrefix

The hotkey prefix.

setLineAlignment(DXStringAlignment value) Method

Specifies the line alignment.

Declaration

public void setLineAlignment(DXStringAlignment value)

Parameters

Name Type Description
value DXStringAlignment

The line alignment.

setTabStops(float[] value) Method

Specifies the tab stops.

Declaration

public void setTabStops(float[] value)

Parameters

Name Type Description
value float[]

The tab stops.

setTrimming(DXStringTrimming value) Method

Specifies the trimming mode.

Declaration

public void setTrimming(DXStringTrimming value)

Parameters

Name Type Description
value DXStringTrimming

The string trimming mode.