com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class Table



  • public class Table
    extends Object

    Represents a table in a Project

    • Constructor Summary

      Constructors 
      Constructor and Description
      Table()
      Default constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(Object obj)
      Returns a value indicating whether this instance is equal to a specified object.
      boolean getAdjustHeaderRowHeight()
      Returns a flag which determines whether the header row height of the table can be adjusted.
      int getDateFormat()
      Gets the date format of the table.
      int getIndex()
      Gets the index of a Table object in the Tables containing object.
      boolean getLockFirstColumn()
      Returns a flag which determines whether the first column of a table is locked or editable.
      String getName()
      Gets the name of a Table object.
      Project getParentProject()
      Gets the parent of the Table object.
      int getRowHeight()
      Gets the row height in a table, where the row height is the number of lines of text.
      boolean getShowAddNewColumn()
      Returns a flag which determines whether to show 'Add New Column' interface.
      boolean getShowInMenu()
      True if 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()
      The unique identifier of a table.
      int hashCode()
      Returns a hash code for this Table.
      void setAdjustHeaderRowHeight(boolean value)
      Sets a flag which determines 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 flag which determines 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 flag which determines whether to show 'Add New Column' interface.
      void setShowInMenu(boolean value)
      Sets a flag which specifies whether to show the table name in the Tables drop-down list on the View tab of the Ribbon.
    • Constructor Detail

      • Table

        public Table()

        Default constructor.

    • Method Detail

      • getAdjustHeaderRowHeight

        public boolean getAdjustHeaderRowHeight()

        Returns a flag which determines whether the header row height of the table can be adjusted.

        Returns:
        a flag which determines whether the header row height of the table can be adjusted.
      • setAdjustHeaderRowHeight

        public void setAdjustHeaderRowHeight(boolean value)

        Sets a flag which determines whether the header row height of the table can be adjusted.

        Parameters:
        value - a flag which determines whether the header row height of the table can be adjusted.
      • getDateFormat

        public int getDateFormat()

        Gets the date format of the table.

        Returns:
        one of the values of the DateFormat class.
      • setDateFormat

        public void setDateFormat(int value)

        Sets the date format of the table.

        Parameters:
        value - one of the values of the DateFormat class.
      • getIndex

        public int getIndex()

        Gets the index of a Table object in the Tables containing object. Read-only int.

        Returns:
        the index of the table in the Tables object.
      • getLockFirstColumn

        public boolean getLockFirstColumn()

        Returns a flag which determines whether the first column of a table is locked or editable.

        Returns:
        a flag which determines whether the first column of a table is locked or editable.
      • setLockFirstColumn

        public void setLockFirstColumn(boolean value)

        Sets a flag which determines whether the first column of a table is locked or editable.

        Parameters:
        value - a flag which determines whether the first column of a table is locked or editable.
      • getName

        public String getName()

        Gets the name of a Table object. Read/write string.

        Returns:
        table name.
      • setName

        public void setName(String value)
        Sets the name of a Table object.
        Parameters:
        value - the specified value.
      • getParentProject

        public Project getParentProject()

        Gets the parent of the Table object. Read-only Project.

        Returns:
        parent project.
      • getRowHeight

        public 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 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 specified row height in a table, where the row height is the number of lines of text.
      • getShowAddNewColumn

        public boolean getShowAddNewColumn()

        Returns a flag which determines whether to show 'Add New Column' interface. Supported by MSP 2010 version and later.

        Returns:
        a flag which determines whether to show 'Add New Column' interface.
      • setShowAddNewColumn

        public void setShowAddNewColumn(boolean value)

        Sets a flag which determines whether to show 'Add New Column' interface. Supported by MSP 2010 version and later.

        Parameters:
        value - a flag which determines whether to show 'Add New Column' interface.
      • getShowInMenu

        public boolean getShowInMenu()

        True if Project shows the table name in the Tables drop-down list on the View tab of the Ribbon. Read/write bool.

        Returns:
        true if Project shows the table name in the Tables drop-down list on the View tab of the Ribbon.
      • setShowInMenu

        public void setShowInMenu(boolean value)
        Sets a flag which specifies whether to show the table name in the Tables drop-down list on the View tab of the Ribbon.
        Parameters:
        value - the specified value.
      • getTableFields

        public TableFieldCollection getTableFields()

        Gets a TableFields collection representing the fields in the table.

        Returns:
        TableFields collection representing the fields in the table.
      • getTableType

        public int getTableType()

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

        Returns:
        table type.
      • getUid

        public int getUid()

        The unique identifier of a table.

        Returns:
        the unique id of the table.
      • 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:
        <b>True</b> if the specified object is a Table that has the same Uid value as this instance; otherwise, <b>false</b>.
      • 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.