TableField

Inheritance: java.lang.Object

public class TableField

Represents a field of a table in a project.

Constructors

ConstructorDescription
TableField()Initializes a new instance of the TableField class.

Methods

MethodDescription
getAlignData()Gets the alignment of data in a table field.
getAlignTitle()Gets the alignment of the title in a table field.
getField()Gets the type of a table field.
getTitle()Gets the title of the field in a table.
getWidth()Gets the width in points of the field column in a table.
getWrapHeader()Gets a value indicating whether the table column heading can wrap to multiple lines, or if it should be truncated when it exceeds the column width.
getWrapText()Gets a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.
setAlignData(int value)Sets the alignment of data in a table field.
setAlignTitle(int value)Sets the alignment of the title in a table field.
setField(int value)Sets the type of a table field.
setTitle(String value)Sets the title of the field in a table.
setWidth(int value)Sets the width in points of the field column in a table.
setWrapHeader(boolean value)Sets a value indicating whether the table column heading can wrap to multiple lines, or if it should be truncated when it exceeds the column width.
setWrapText(boolean value)Sets a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

TableField()

public TableField()

Initializes a new instance of the TableField class.

getAlignData()

public final int getAlignData()

Gets the alignment of data in a table field.

Returns: int - the alignment of data in a table field.

getAlignTitle()

public final int getAlignTitle()

Gets the alignment of the title in a table field.

Returns: int - the alignment of the title in a table field.

getField()

public final int getField()

Gets the type of a table field.

Returns: int - the type of a table field.

getTitle()

public final String getTitle()

Gets the title of the field in a table.

Returns: java.lang.String - the title of the field in a table.

getWidth()

public final int getWidth()

Gets the width in points of the field column in a table.

Returns: int - the width in points of the field column in a table.

getWrapHeader()

public final boolean getWrapHeader()

Gets a value indicating whether the table column heading can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

Returns: boolean - a value indicating whether the table column heading can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

getWrapText()

public final boolean getWrapText()

Gets a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.


Supported by MSP 2010 version and later.

Returns: boolean - a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

setAlignData(int value)

public final void setAlignData(int value)

Sets the alignment of data in a table field.

Parameters:

ParameterTypeDescription
valueintthe alignment of data in a table field.

setAlignTitle(int value)

public final void setAlignTitle(int value)

Sets the alignment of the title in a table field.

Parameters:

ParameterTypeDescription
valueintthe alignment of the title in a table field.

setField(int value)

public final void setField(int value)

Sets the type of a table field.

Parameters:

ParameterTypeDescription
valueintthe type of a table field.

setTitle(String value)

public final void setTitle(String value)

Sets the title of the field in a table.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe title of the field in a table.

setWidth(int value)

public final void setWidth(int value)

Sets the width in points of the field column in a table.

Parameters:

ParameterTypeDescription
valueintthe width in points of the field column in a table.

setWrapHeader(boolean value)

public final void setWrapHeader(boolean value)

Sets a value indicating whether the table column heading can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether the table column heading can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

setWrapText(boolean value)

public final void setWrapText(boolean value)

Sets a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.


Supported by MSP 2010 version and later.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.