Excel.TableStyle class
Represents a table style, which defines the style elements by region of the table.
- Extends
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
name | Specifies the name of the table style. |
read |
Specifies if this |
delete() | Deletes the table style. |
duplicate() | Creates a duplicate of this table style with copies of all the style elements. |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
toJSON() | Overrides the JavaScript |
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
Specifies the name of the table style.
name: string;
Property Value
string
Remarks
Specifies if this TableStyle
object is read-only.
readonly readOnly: boolean;
Property Value
boolean
Remarks
Creates a duplicate of this table style with copies of all the style elements.
duplicate(): Excel.TableStyle;
Returns
The new TableStyle
object that has been duplicated from this table style.
Remarks
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Excel.Interfaces.TableStyleLoadOptions): Excel.TableStyle;
Parameters
Provides options for which properties of the object to load.
Returns
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Excel.TableStyle;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TableStyle;
Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameters
- properties
- Excel.Interfaces.TableStyleUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.TableStyle): void;
Parameters
- properties
- Excel.TableStyle
Returns
void
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Excel.TableStyle
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.TableStyleData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.TableStyleData;
Returns
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: