com.aspose.tasks

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.tasks

Class TableField


  • public class TableField
extends Object

    Represents a field of a table in a project.

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      int getAlignData()
      Gets the alignment of data in a table field.
      int getAlignTitle()
      Gets the alignment of the title in a table field.
      int getField()
      Gets the type of a table field.
      Table getParentTable()
      Deprecated. 
      This property is obsolete and will be removed after the release 21.03.
      String getTitle()
      Gets the title of the field in a table.
      int getWidth()
      Gets the width in points of the field column in a table.
      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.
      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.
      void setAlignData(int value)
      Sets the alignment of data in a table field.
      void setAlignTitle(int value)
      Sets the alignment of the title in a table field.
      void setField(int value)
      Sets the type of a table field.
      void setTitle(String value)
      Sets the title of the field in a table.
      void setWidth(int value)
      Sets the width in points of the field column in a table.
      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.
      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.

    • Constructor Detail

      • TableField

        public TableField()

        Initializes a new instance of the TableField class.

    • Method Detail

      • getAlignData

        public final int getAlignData()

        Gets the alignment of data in a table field.

        Returns:
        the alignment of data in a table field.

      • setAlignData

        public final void setAlignData(int value)

        Sets the alignment of data in a table field.

        Parameters:
        value - the alignment of data in a table field.

      • getAlignTitle

        public final int getAlignTitle()

        Gets the alignment of the title in a table field.

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

      • setAlignTitle

        public final void setAlignTitle(int value)

        Sets the alignment of the title in a table field.

        Parameters:
        value - the alignment of the title in a table field.

      • getField

        public final int getField()

        Gets the type of a table field.

        Returns:
        the type of a table field.

      • setField

        public final void setField(int value)

        Sets the type of a table field.

        Parameters:
        value - the type of a table field.

      • getParentTable

        @Deprecated
public final Table getParentTable()
        Deprecated. This property is obsolete and will be removed after the release 21.03.

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

        Returns:
        the parent of the TableField object.

      • getTitle

        public final String getTitle()

        Gets the title of the field in a table.

        Returns:
        the title of the field in a table.

      • setTitle

        public final void setTitle(String value)

        Sets the title of the field in a table.

        Parameters:
        value - 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:
        the width in points of the field column in a table.

      • setWidth

        public final void setWidth(int value)

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

        Parameters:
        value - 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:
        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.

      • setWrapHeader

        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:
        value - 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:
        a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.

      • setWrapText

        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:
        value - a value indicating whether the column text can wrap to multiple lines, or if it should be truncated when it exceeds the column width.