Table

Inheritance: java.lang.Object

public class Table

Represents a table in Project

Constructors

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

Methods

MethodDescription
equals(Object obj)Returns a value indicating whether this instance is equal to a specified object.
getAdjustHeaderRowHeight()Gets a value indicating whether the header row height of the table can be adjusted.
getDateFormat()Gets the date format of the table.
getIndex()Gets the index of a Table object in the Tables containing object.
getLockFirstColumn()Gets a value indicating whether the first column of a table is locked or editable.
getName()Gets the name of a Table object.
getRowHeight()Gets the row height in a table, where the row height is the number of lines of text.
getShowAddNewColumn()Gets a value indicating whether to show ‘Add New Column’ interface.
getShowInMenu()Gets a value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.
getTableFields()Gets a TableFields collection representing the fields in the table.
getTableType()Gets the table type for the specified table.
getUid()Gets the unique identifier of a table.
hashCode()Returns a hash code for this Table.
setAdjustHeaderRowHeight(boolean value)Sets a value indicating whether the header row height of the table can be adjusted.
setDateFormat(int value)Sets the date format of the table.
setLockFirstColumn(boolean value)Sets a value indicating whether the first column of a table is locked or editable.
setName(String value)Sets the name of a Table object.
setRowHeight(int value)Sets the row height in a table, where the row height is the number of lines of text.
setShowAddNewColumn(boolean value)Sets a value indicating whether to show ‘Add New Column’ interface.
setShowInMenu(boolean value)Sets a value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.

Table()

public Table()

Initializes a new instance of the Table class.

equals(Object obj)

public boolean equals(Object obj)

Returns a value indicating whether this instance is equal to a specified object.

Parameters:

ParameterTypeDescription
objjava.lang.ObjectThe object to compare with this instance.

Returns: boolean - True if the specified object is a Table that has the same UID value as this instance; otherwise, false.

getAdjustHeaderRowHeight()

public final boolean getAdjustHeaderRowHeight()

Gets a value indicating whether the header row height of the table can be adjusted.

Returns: boolean - a value indicating whether the header row height of the table can be adjusted.

getDateFormat()

public final int getDateFormat()

Gets the date format of the table.

Returns: int - the date format of the table.

getIndex()

public final int getIndex()

Gets the index of a Table object in the Tables containing object.

Returns: int - the index of a Table object in the Tables containing object.

getLockFirstColumn()

public final boolean getLockFirstColumn()

Gets a value indicating whether the first column of a table is locked or editable.

Returns: boolean - a value indicating whether the first column of a table is locked or editable.

getName()

public final String getName()

Gets the name of a Table object.

Returns: java.lang.String - the name of a Table object.

getRowHeight()

public final int getRowHeight()

Gets the row height in a table, where the row height is the number of lines of text.

Returns: int - the row height in a table, where the row height is the number of lines of text.

getShowAddNewColumn()

public final boolean getShowAddNewColumn()

Gets a value indicating whether to show ‘Add New Column’ interface.


Supported by MSP 2010 version and later.

Returns: boolean - a value indicating whether to show ‘Add New Column’ interface.

getShowInMenu()

public final boolean getShowInMenu()

Gets a value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.

Returns: boolean - a value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.

getTableFields()

public final TableFieldCollection getTableFields()

Gets a TableFields collection representing the fields in the table.

Returns: TableFieldCollection - a TableFields collection representing the fields in the table.

getTableType()

public final int getTableType()

Gets the table type for the specified table. Read-only ItemType.

Returns: int - the table type for the specified table.

getUid()

public final int getUid()

Gets the unique identifier of a table.

Returns: int - the unique identifier of a table.

hashCode()

public int hashCode()

Returns a hash code for this Table.

Returns: int - Returns a hash code value for this object.

setAdjustHeaderRowHeight(boolean value)

public final void setAdjustHeaderRowHeight(boolean value)

Sets a value indicating whether the header row height of the table can be adjusted.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether the header row height of the table can be adjusted.

setDateFormat(int value)

public final void setDateFormat(int value)

Sets the date format of the table.

Parameters:

ParameterTypeDescription
valueintthe date format of the table.

setLockFirstColumn(boolean value)

public final void setLockFirstColumn(boolean value)

Sets a value indicating whether the first column of a table is locked or editable.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether the first column of a table is locked or editable.

setName(String value)

public final void setName(String value)

Sets the name of a Table object.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe name of a Table object.

setRowHeight(int value)

public final void setRowHeight(int value)

Sets the row height in a table, where the row height is the number of lines of text.

Parameters:

ParameterTypeDescription
valueintthe row height in a table, where the row height is the number of lines of text.

setShowAddNewColumn(boolean value)

public final void setShowAddNewColumn(boolean value)

Sets a value indicating whether to show ‘Add New Column’ interface.


Supported by MSP 2010 version and later.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether to show ‘Add New Column’ interface.

setShowInMenu(boolean value)

public final void setShowInMenu(boolean value)

Sets a value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.