ig.excel.WorksheetTableStyle
Dependencies
-
ig.excel.WorksheetTableStyle
Constructor- new $.ig.excel.WorksheetTableStyle( name:string );
Creates a custom WorksheetTableStyle instance.
- name
- Type:string
- The name of the new style.
Exceptions
Exception Description ig.ArgumentNullException name is null or empty. -
alternateColumnStripeWidth
- .alternateColumnStripeWidth( );
- Return Type:
- number
- Return Type Description:
- The number of columns which will span each alternate column stripe.
Gets the number of columns which will span each alternate column stripe.
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The column stripes are assigned from left to right in the table, first assigning the column stripe, then the alternate column stripe, then repeating.
The alternate column stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.AlternateColumnStripe value.
-
alternateColumnStripeWidth
- .alternateColumnStripeWidth( value:number );
- Return Type:
- number
- Return Type Description:
- The number of columns which will span each alternate column stripe.
Sets the number of columns which will span each alternate column stripe.
- value
- Type:number
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The column stripes are assigned from left to right in the table, first assigning the column stripe, then the alternate column stripe, then repeating.
The alternate column stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.AlternateColumnStripe value.
-
alternateRowStripeHeight
- .alternateRowStripeHeight( );
- Return Type:
- number
- Return Type Description:
- The number of rows which will span each alternate row stripe.
Gets the number of rows which will span each alternate row stripe.
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The row stripes are assigned from top to bottom in the table, first assigning the row stripe, then the alternate row stripe, then repeating.
The alternate row stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.AlternateRowStripe value.
-
alternateRowStripeHeight
- .alternateRowStripeHeight( value:number );
- Return Type:
- number
- Return Type Description:
- The number of rows which will span each alternate row stripe.
Sets the number of rows which will span each alternate row stripe.
- value
- Type:number
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The row stripes are assigned from top to bottom in the table, first assigning the row stripe, then the alternate row stripe, then repeating.
The alternate row stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.AlternateRowStripe value.
-
areaFormats
- .areaFormats( );
Gets the collection of formats used for each area of a WorksheetTable to which the style is applied.
Remarks
The area formats specified are differential formats. In other words, only the properties that are set to non-default values will be applied to the appropriate cells. An area format can define only a background color or only font information and that format will be applied to the cells while all other formatting properties on the cells will be maintained.
-
areaFormats
- .areaFormats( area:ig.excel.WorksheetTableStyleArea );
- Return Type:
- ig.excel.IWorksheetCellFormat
- Return Type Description:
- An IWorksheetCellFormat instance describing the appearance of the specified area.
Gets the format for the specified area.
- area
- Type:ig.excel.WorksheetTableStyleArea
- The area for which to get the format.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException area is not defined. -
clone
- .clone( name:string );
- Return Type:
- ig.excel.WorksheetTableStyle
- Return Type Description:
- The clone of the style.
Duplicates the style and returns a deep copy.
- name
- Type:string
- The name to give to the cloned style.
Exceptions
Exception Description ig.ArgumentNullException name is null or empty. Remarks
A cloned style must be added to the Workbook.customTableStyles collection before it can be applied to a WorksheetTable.
The only value not cloned from the style is the WorksheetTableStyle.isCustom value. Cloning a standard style creates a custom style with the same style settings which can then be changed.
-
columnStripeWidth
- .columnStripeWidth( );
- Return Type:
- number
- Return Type Description:
- The number of columns which will span each column stripe.
Gets the number of columns which will span each column stripe.
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The column stripes are assigned from left to right in the table, first assigning the column stripe, then the alternate column stripe, then repeating.
The column stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.ColumnStripe value.
-
columnStripeWidth
- .columnStripeWidth( value:number );
- Return Type:
- number
- Return Type Description:
- The number of columns which will span each column stripe.
Sets the number of columns which will span each column stripe.
- value
- Type:number
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The column stripes are assigned from left to right in the table, first assigning the column stripe, then the alternate column stripe, then repeating.
The column stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.ColumnStripe value.
-
isCustom
- .isCustom( );
- Return Type:
- boolean
- Return Type Description:
- True id this is a custom table style; False if this is a read-only, standard table style.
Gets the value indicating whether the style is a custom style.
-
name
- .name( );
- Return Type:
- string
- Return Type Description:
- The name of the style.
Gets the name of the style.
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentException The value assigned is null, empty, or greater than 255 characters in length. ig.ArgumentException The value assigned matches the name of another custom style in the owning Workbook.customTableStyles collection. Table names are compared case-insensitively. -
name
- .name( value:string );
- Return Type:
- string
- Return Type Description:
- The name of the style.
Sets the name of the style.
- value
- Type:string
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentException The value assigned is null, empty, or greater than 255 characters in length. ig.ArgumentException The value assigned matches the name of another custom style in the owning Workbook.customTableStyles collection. Table names are compared case-insensitively. -
rowStripeHeight
- .rowStripeHeight( );
- Return Type:
- number
- Return Type Description:
- The number of rows which will span each row stripe.
Gets the number of rows which will span each row stripe.
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The row stripes are assigned from top to bottom in the table, first assigning the row stripe, then the alternate row stripe, then repeating.
The row stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.RowStripe value.
-
rowStripeHeight
- .rowStripeHeight( value:number );
- Return Type:
- number
- Return Type Description:
- The number of rows which will span each row stripe.
Sets the number of rows which will span each row stripe.
- value
- Type:number
Exceptions
Exception Description ig.InvalidOperationException The value is set and WorksheetTableStyle.isCustom is False, indicating that the style is a read-only, standard table style. ig.ArgumentOutOfRangeException The value assigned is less than 1 or greater than 9. Remarks
The stripe sizes must be between 1 and 9, inclusive.
The row stripes are assigned from top to bottom in the table, first assigning the row stripe, then the alternate row stripe, then repeating.
The row stripe format is defined in the WorksheetTableStyle.areaFormats collection and keyed by the WorksheetTableStyleArea.RowStripe value.