Word.TableColumn class
Represents a table column in a Word document.
- Extends
Remarks
Properties
| borders | Returns a |
| column |
Returns the position of this column in a collection. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| is |
Returns |
| is |
Returns |
| nesting |
Returns the nesting level of the column. |
| preferred |
Specifies the preferred width (in points or as a percentage of the window width) for the column. The unit of measurement can be specified by the |
| preferred |
Specifies the preferred unit of measurement to use for the width of the table column. |
| shading | Returns a |
| width | Specifies the width of the column, in points. |
Methods
| auto |
Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells. |
| delete() | Deletes the column. |
| 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 |
| select() | Selects the table column. |
| 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. |
| set |
Sets the width of the column in a table. |
| set |
Sets the width of the column in a table. |
| sort() | Sorts the table column. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
borders
Returns a BorderUniversalCollection object that represents all the borders for the table column.
readonly borders: Word.BorderUniversalCollection;Property Value
Remarks
columnIndex
Returns the position of this column in a collection.
readonly columnIndex: number;Property Value
number
Remarks
context
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
isFirst
Returns true if the column or row is the first one in the table; false otherwise.
readonly isFirst: boolean;Property Value
boolean
Remarks
isLast
Returns true if the column or row is the last one in the table; false otherwise.
readonly isLast: boolean;Property Value
boolean
Remarks
nestingLevel
Returns the nesting level of the column.
readonly nestingLevel: number;Property Value
number
Remarks
preferredWidth
Specifies the preferred width (in points or as a percentage of the window width) for the column. The unit of measurement can be specified by the preferredWidthType property.
preferredWidth: number;Property Value
number
Remarks
preferredWidthType
Specifies the preferred unit of measurement to use for the width of the table column.
preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";Property Value
Word.PreferredWidthType | "Auto" | "Percent" | "Points"
Remarks
shading
Returns a ShadingUniversal object that refers to the shading formatting for the column.
readonly shading: Word.ShadingUniversal;Property Value
Remarks
width
Specifies the width of the column, in points.
width: number;Property Value
number
Remarks
Method Details
autoFit()
Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells.
autoFit(): void;Returns
void
Remarks
delete()
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
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[]): Word.TableColumn;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
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;
}): Word.TableColumn;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
select()
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: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.TableColumnUpdateData
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
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.TableColumn): void;Parameters
- properties
- Word.TableColumn
Returns
void
setWidth(columnWidth, rulerStyle)
Sets the width of the column in a table.
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;Parameters
- columnWidth
-
number
The width to set.
- rulerStyle
- Word.RulerStyle
The ruler style to apply.
Returns
void
Remarks
setWidth(columnWidth, rulerStyle)
Sets the width of the column in a table.
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Parameters
- columnWidth
-
number
The width to set.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
The ruler style to apply.
Returns
void
Remarks
sort()
toJSON()
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's passed to it.) Whereas the original Word.TableColumn object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.TableColumnData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.TableColumnData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.TableColumn;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.TableColumn;