Edit

Share via

Word.TableConvertToTextOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the options for the Table.convertToText, TableRow.convertToText, and TableRowCollection.convertToText methods.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

nestedTables

If provided, specifies whether to convert the nested tables to text. This property is ignored if the separator property isn't set to paragraph. The default is true.
separator

If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is tab.

Property Details

nestedTables

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies whether to convert the nested tables to text. This property is ignored if the separator property isn't set to paragraph. The default is true.

nestedTables?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

separator

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is tab.

separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator";

Property Value

Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]