TableStyle

Overview

TableStyle is a class in Aspose.Words FOSS for Java. Inherits from: Style, ICellAttrSource, IRowAttrSource, and 2 more.

Represents a table style.

Edition status of its 92 listed members (a property and its accessor methods are listed separately, overloads once): 92 not yet exercised by a verified example.

This class declares 58 methods for TableStyle objects in Java programs. Available methods include: equals, getAliases, getAlignment, getAllowBreakAcrossPages, getAutomaticallyUpdate, getBaseStyleName, getBorders, getBottomPadding, getBuiltIn, getCellSpacing, getColumnStripe, getConditionalStyles, and 45 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: aliases, alignment, allowBreakAcrossPages, automaticallyUpdate, baseStyleName, borders, and 29 more.

Properties

NameTypeAccessDescription
allowBreakAcrossPagesbooleanRead/WriteGets or sets a flag indicating whether text in a table row is allowed to split across a page break.
bordersBorderCollectionReadGets the collection of default cell borders for the style.
leftPaddingdoubleRead/WriteGets or sets the amount of space (in points) to add to the left of the contents of table cells.
rightPaddingdoubleRead/WriteGets or sets the amount of space (in points) to add to the right of the contents of table cells.
topPaddingdoubleRead/WriteGets or sets the amount of space (in points) to add above the contents of table cells.
bottomPaddingdoubleRead/WriteGets or sets the amount of space (in points) to add below the contents of table cells.
alignmentintRead/WriteSpecifies the alignment for the table style.
cellSpacingdoubleRead/WriteGets or sets the amount of space (in points) between the cells.
leftIndentdoubleRead/WriteGets or sets the value that represents the left indent of a table.
shadingShadingReadGets a Shading object that refers to the shading formatting for table cells.
verticalAlignmentintRead/WriteSpecifies the vertical alignment for the cells.
rowStripeintRead/WriteGets or sets a number of rows to include in the banding when the style specifies odd/even row banding.
columnStripeintRead/WriteGets or sets a number of columns to include in the banding when the style specifies odd/even columns banding.
conditionalStylesConditionalStyleCollectionReadCollection of conditional styles that may be defined for this table style.
nameStringRead/WriteGets or sets the name of the style.
styleIdentifierintReadGets the locale independent style identifier for a built-in style.
aliasesString[]ReadGets the aliases.
headingbooleanReadTrue when the style is one of the built-in Heading styles.
typeintReadGets the type.
documentDocumentBaseReadGets the owner document.
linkedStyleNameStringRead/WriteGets/sets the name of the Style linked to this one.
baseStyleNameStringRead/WriteGets/sets the name of the style this style is based on.
nextParagraphStyleNameStringRead/WriteGets/sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
builtInbooleanReadTrue if this style is one of the built-in styles in MS Word.
fontFontReadGets the character formatting of the style.
paragraphFormatParagraphFormatReadGets the paragraph formatting of the style.
semiHiddenbooleanRead/WriteGets/sets whether the style hides from the Styles gallery and from the Styles task pane.
unhideWhenUsedbooleanRead/WriteGets/sets whether the style used in the current document unhides from the Styles gallery and from the Styles task pane.
priorityintRead/WriteGets/sets the integer value that represents the priority for sorting the styles in the Styles task pane.
listListReadGets the list that defines formatting of this list style.
listFormatListFormatReadProvides access to the list formatting properties of a paragraph style.
quickStylebooleanRead/WriteSpecifies whether this style is shown in the Quick Style gallery inside MS Word UI.
automaticallyUpdatebooleanRead/WriteSpecifies whether this style is automatically redefined based on the appropriate value.
lockedbooleanRead/WriteSpecifies whether this style is locked.
stylesStyleCollectionReadGets the collection of styles this style belongs to.

Methods

SignatureDescription
getAllowBreakAcrossPages() → booleanGets or sets a flag indicating whether text in a table row is allowed to split across a page break.
setAllowBreakAcrossPages(value: boolean)Sets the allow break across pages value.
getBorders() → BorderCollectionGets the collection of default cell borders for the style.
getLeftPadding() → doubleGets or sets the amount of space (in points) to add to the left of the contents of table cells.
setLeftPadding(value: double)Sets the left padding value.
getRightPadding() → doubleGets or sets the amount of space (in points) to add to the right of the contents of table cells.
setRightPadding(value: double)Sets the right padding value.
getTopPadding() → doubleGets or sets the amount of space (in points) to add above the contents of table cells.
setTopPadding(value: double)Sets the top padding value.
getBottomPadding() → doubleGets or sets the amount of space (in points) to add below the contents of table cells.
setBottomPadding(value: double)Sets the bottom padding value.
getAlignment() → intSpecifies the alignment for the table style.
setAlignment(value: int)Sets the alignment value.
getCellSpacing() → doubleGets or sets the amount of space (in points) between the cells.
setCellSpacing(value: double)Sets the cell spacing value.
getLeftIndent() → doubleGets or sets the value that represents the left indent of a table.
setLeftIndent(value: double)Sets the left indent value.
getShading() → ShadingGets a Shading object that refers to the shading formatting for table cells.
getVerticalAlignment() → intSpecifies the vertical alignment for the cells.
setVerticalAlignment(value: int)Sets the vertical alignment value.
getRowStripe() → intGets or sets a number of rows to include in the banding when the style specifies odd/even row banding.
setRowStripe(value: int)Sets the row stripe value.
getColumnStripe() → intGets or sets a number of columns to include in the banding when the style specifies odd/even columns banding.
setColumnStripe(value: int)Sets the column stripe value.
getConditionalStyles() → ConditionalStyleCollectionCollection of conditional styles that may be defined for this table style.
getName() → StringGets or sets the name of the style.
setName(value: String)Sets the name value.
getStyleIdentifier() → intGets the locale independent style identifier for a built-in style.
getAliases() → String[]Returns the aliases.
isHeading() → booleanTrue when the style is one of the built-in Heading styles.
getType() → intReturns the type.
getDocument() → DocumentBaseGets the owner document.
getLinkedStyleName() → StringGets/sets the name of the Style linked to this one.
setLinkedStyleName(value: String)Sets the linked style name value.
getBaseStyleName() → StringGets/sets the name of the style this style is based on.
setBaseStyleName(value: String)Sets the base style name value.
getNextParagraphStyleName() → StringGets/sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
setNextParagraphStyleName(value: String)Sets the next paragraph style name value.
getBuiltIn() → booleanTrue if this style is one of the built-in styles in MS Word.
getFont() → FontGets the character formatting of the style.
getParagraphFormat() → ParagraphFormatGets the paragraph formatting of the style.
getSemiHidden() → booleanGets/sets whether the style hides from the Styles gallery and from the Styles task pane.
setSemiHidden(value: boolean)Sets the semi hidden value.
getUnhideWhenUsed() → booleanGets/sets whether the style used in the current document unhides from the Styles gallery and from the Styles task pane.
setUnhideWhenUsed(value: boolean)Sets the unhide when used value.
getPriority() → intGets/sets the integer value that represents the priority for sorting the styles in the Styles task pane.
setPriority(value: int)Sets the priority value.
getList() → ListGets the list that defines formatting of this list style.
getListFormat() → ListFormatProvides access to the list formatting properties of a paragraph style.
isQuickStyle() → booleanSpecifies whether this style is shown in the Quick Style gallery inside MS Word UI.
isQuickStyle(value: boolean)Calls isQuickStyle(value) on this TableStyle instance.
getAutomaticallyUpdate() → booleanSpecifies whether this style is automatically redefined based on the appropriate value.
setAutomaticallyUpdate(value: boolean)Sets the automatically update value.
getLocked() → booleanSpecifies whether this style is locked.
setLocked(value: boolean)Sets the locked value.
getStyles() → StyleCollectionGets the collection of styles this style belongs to.
remove()Removes the specified style from the document.
equals(style: Style) → booleanCompares with the specified style.

See Also