Word.TableColumn class

Returns a BorderUniversalCollection object that represents all the borders for the table column.

readonly borders: Word.BorderUniversalCollection;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns the position of this column in a collection.

readonly columnIndex: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Returns true if the column or row is the first one in the table; false otherwise.

readonly isFirst: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns true if the column or row is the last one in the table; false otherwise.

readonly isLast: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns the nesting level of the column.

readonly nestingLevel: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the preferred unit of measurement to use for the width of the table column.

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Returns a ShadingUniversal object that refers to the shading formatting for the column.

readonly shading: Word.ShadingUniversal;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the width of the column, in points.

width: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Deletes the column.

delete(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

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[]): Word.TableColumn;

Parameters

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;
        }): Word.TableColumn;

Parameters

Returns

Selects the table column.

select(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.TableColumn): void;

Parameters

Returns

Sets the width of the column in a table.

setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets the width of the column in a table.

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sorts the table column.

sort(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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 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

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;

Returns