Package com.aspose.tasks

Class Table

  • public class Table
extends Object

    Represents a table in Project

    • Constructor Summary

      Constructors 
      Constructor Description
      Table()
      Initializes a new instance of the Table class.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)
      Returns a value indicating whether this instance is equal to a specified object.
      boolean getAdjustHeaderRowHeight()
      Gets a value indicating whether the header row height of the table can be adjusted.
      int getDateFormat()
      Gets the date format of the table.
      int getIndex()
      Deprecated.
      This member is obsolete and will be removed after release 25.7.
      boolean getLockFirstColumn()
      Gets a value indicating whether the first column of a table is locked or editable.
      String getName()
      Gets the name of a Table object.
      int getRowHeight()
      Gets the row height in a table, where the row height is the number of lines of text.
      boolean getShowAddNewColumn()
      Gets a value indicating whether to show 'Add New Column' interface.
      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.
      TableFieldCollection getTableFields()
      Gets a TableFields collection representing the fields in the table.
      int getTableType()
      Gets the table type for the specified table.
      int getUid()
      Gets the unique identifier of a table.
      int hashCode()
      Returns a hash code for this Table.
      void setAdjustHeaderRowHeight​(boolean value)
      Sets a value indicating whether the header row height of the table can be adjusted.
      void setDateFormat​(int value)
      Sets the date format of the table.
      void setLockFirstColumn​(boolean value)
      Sets a value indicating whether the first column of a table is locked or editable.
      void setName​(String value)
      Sets the name of a Table object.
      void setRowHeight​(int value)
      Sets the row height in a table, where the row height is the number of lines of text.
      void setShowAddNewColumn​(boolean value)
      Sets a value indicating whether to show 'Add New Column' interface.
      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.
      void setTableType​(int value)
      Sets the table type for the specified table.

    • Constructor Detail

      • Table

        public Table()

        Initializes a new instance of the Table class.

    • Method Detail

      • equals

        public boolean equals​(Object obj)

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

        Overrides:
        equals in class Object
        Parameters:
        obj - The object to compare with this instance.
        Returns:
        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:
        a value indicating whether the header row height of the table can be adjusted.

      • setAdjustHeaderRowHeight

        public final void setAdjustHeaderRowHeight​(boolean value)

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

        Parameters:
        value - 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:
        the date format of the table.

      • setDateFormat

        public final void setDateFormat​(int value)

        Sets the date format of the table.

        Parameters:
        value - the date format of the table.

      • getIndex

        @Deprecated
public final int getIndex()
        Deprecated.
        This member is obsolete and will be removed after release 25.7.

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

        Returns:
        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:
        a value indicating whether the first column of a table is locked or editable.

      • setLockFirstColumn

        public final void setLockFirstColumn​(boolean value)

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

        Parameters:
        value - 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:
        the name of a Table object.

      • setName

        public final void setName​(String value)

        Sets the name of a Table object.

        Parameters:
        value - 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:
        the row height in a table, where the row height is the number of lines of text.

      • setRowHeight

        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:
        value - 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:
        a value indicating whether to show 'Add New Column' interface.

      • setShowAddNewColumn

        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:
        value - 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:
        a value indicating whether project shows the table name in the Tables drop-down list on the View tab of the Ribbon.

      • setShowInMenu

        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:
        value - 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:
        a TableFields collection representing the fields in the table.

      • getTableType

        public final int getTableType()

        Gets the table type for the specified table.

        Returns:
        the table type for the specified table.

      • setTableType

        public final void setTableType​(int value)

        Sets the table type for the specified table.

        Parameters:
        value - the table type for the specified table.

      • getUid

        public final int getUid()

        Gets the unique identifier of a table.

        Returns:
        the unique identifier of a table.

      • hashCode

        public int hashCode()

        Returns a hash code for this Table.

        Overrides:
        hashCode in class Object
        Returns:
        Returns a hash code value for this object.