Interface DocxFileFormatSettings

interface DocxFileFormatSettings {
    addLineSeparatorAsCharacter?: boolean;
    addTabAsCharacter?: boolean;
    allowWordStyleOptimization?: boolean;
    cleanTagsAggressively?: boolean;
    complexFieldDefinitionsToExtract?: string[];
    contentSegmentation?: boolean;
    customSegmentation?: boolean;
    excelExcludedColors?: string[];
    excludeWordStyles?: string[];
    exportPattern?: string;
    ignoreSoftHyphenTag?: boolean;
    ignoreWhitespaceStyles?: boolean;
    ignoreWordFontColors?: boolean;
    importHiddenSlides?: boolean;
    importNotes?: boolean;
    lineSeparatorReplacement?: string;
    replaceNoBreakHyphenTag?: boolean;
    srxStorageId?: number;
    translateComments?: boolean;
    translateDocProperties?: boolean;
    translateExcelCellsCopied?: boolean;
    translateExcelDiagramData?: boolean;
    translateExcelDrawings?: boolean;
    translateExcelExcludeColors?: boolean;
    translateExcelSheetNames?: boolean;
    translateHiddenRowsAndColumns?: boolean;
    translateHiddenText?: boolean;
    translateHyperlinkUrls?: boolean;
    translateWordExcludeColors?: boolean;
    translateWordGraphicDescription?: boolean;
    translateWordGraphicName?: boolean;
    translateWordHeadersFooters?: boolean;
    translateWordInExcludeHighlightMode?: boolean;
    translateWordInExcludeStyleMode?: boolean;
    wordExcludedColors?: string[];
    wordFontColorsMaxIgnoranceThreshold?: string;
    wordFontColorsMinIgnoranceThreshold?: string;
    wordHighlightColors?: string[];
}

Hierarchy (view full)

Properties

addLineSeparatorAsCharacter? addTabAsCharacter? allowWordStyleOptimization? cleanTagsAggressively? complexFieldDefinitionsToExtract? contentSegmentation? customSegmentation? excelExcludedColors? excludeWordStyles? exportPattern? ignoreSoftHyphenTag? ignoreWhitespaceStyles? ignoreWordFontColors? importHiddenSlides? importNotes? lineSeparatorReplacement? replaceNoBreakHyphenTag? srxStorageId? translateComments? translateDocProperties? translateExcelCellsCopied? translateExcelDiagramData? translateExcelDrawings? translateExcelExcludeColors? translateExcelSheetNames? translateHiddenRowsAndColumns? translateHiddenText? translateHyperlinkUrls? translateWordExcludeColors? translateWordGraphicDescription? translateWordGraphicName? translateWordHeadersFooters? translateWordInExcludeHighlightMode? translateWordInExcludeStyleMode? wordExcludedColors? wordFontColorsMaxIgnoranceThreshold? wordFontColorsMinIgnoranceThreshold? wordHighlightColors?

Properties

OptionaladdLineSeparatorAsCharacter

addLineSeparatorAsCharacter?: boolean

OptionaladdTabAsCharacter

addTabAsCharacter?: boolean

OptionalallowWordStyleOptimization

allowWordStyleOptimization?: boolean

OptionalcleanTagsAggressively

cleanTagsAggressively?: boolean

OptionalcomplexFieldDefinitionsToExtract

complexFieldDefinitionsToExtract?: string[]

OptionalcontentSegmentation

contentSegmentation?: boolean

OptionalcustomSegmentation

customSegmentation?: boolean

Returned in responses only

OptionalexcelExcludedColors

excelExcludedColors?: string[]

OptionalexcludeWordStyles

excludeWordStyles?: string[]

OptionalexportPattern

exportPattern?: string

OptionalignoreSoftHyphenTag

ignoreSoftHyphenTag?: boolean

OptionalignoreWhitespaceStyles

ignoreWhitespaceStyles?: boolean

OptionalignoreWordFontColors

ignoreWordFontColors?: boolean

OptionalimportHiddenSlides

importHiddenSlides?: boolean

OptionalimportNotes

importNotes?: boolean

OptionallineSeparatorReplacement

lineSeparatorReplacement?: string

OptionalreplaceNoBreakHyphenTag

replaceNoBreakHyphenTag?: boolean

OptionalsrxStorageId

srxStorageId?: number

OptionaltranslateComments

translateComments?: boolean

OptionaltranslateDocProperties

translateDocProperties?: boolean

OptionaltranslateExcelCellsCopied

translateExcelCellsCopied?: boolean

OptionaltranslateExcelDiagramData

translateExcelDiagramData?: boolean

OptionaltranslateExcelDrawings

translateExcelDrawings?: boolean

OptionaltranslateExcelExcludeColors

translateExcelExcludeColors?: boolean

OptionaltranslateExcelSheetNames

translateExcelSheetNames?: boolean

OptionaltranslateHiddenRowsAndColumns

translateHiddenRowsAndColumns?: boolean

OptionaltranslateHiddenText

translateHiddenText?: boolean

OptionaltranslateHyperlinkUrls

translateHyperlinkUrls?: boolean

OptionaltranslateWordExcludeColors

translateWordExcludeColors?: boolean

OptionaltranslateWordGraphicDescription

translateWordGraphicDescription?: boolean

OptionaltranslateWordGraphicName

translateWordGraphicName?: boolean

OptionaltranslateWordHeadersFooters

translateWordHeadersFooters?: boolean

OptionaltranslateWordInExcludeHighlightMode

translateWordInExcludeHighlightMode?: boolean

OptionaltranslateWordInExcludeStyleMode

translateWordInExcludeStyleMode?: boolean

OptionalwordExcludedColors

wordExcludedColors?: string[]

OptionalwordFontColorsMaxIgnoranceThreshold

wordFontColorsMaxIgnoranceThreshold?: string

OptionalwordFontColorsMinIgnoranceThreshold

wordFontColorsMinIgnoranceThreshold?: string

OptionalwordHighlightColors

wordHighlightColors?: string[]

Settings

Member Visibility

On This Page

Properties
addLineSeparatorAsCharacteraddTabAsCharacterallowWordStyleOptimizationcleanTagsAggressivelycomplexFieldDefinitionsToExtractcontentSegmentationcustomSegmentationexcelExcludedColorsexcludeWordStylesexportPatternignoreSoftHyphenTagignoreWhitespaceStylesignoreWordFontColorsimportHiddenSlidesimportNoteslineSeparatorReplacementreplaceNoBreakHyphenTagsrxStorageIdtranslateCommentstranslateDocPropertiestranslateExcelCellsCopiedtranslateExcelDiagramDatatranslateExcelDrawingstranslateExcelExcludeColorstranslateExcelSheetNamestranslateHiddenRowsAndColumnstranslateHiddenTexttranslateHyperlinkUrlstranslateWordExcludeColorstranslateWordGraphicDescriptiontranslateWordGraphicNametranslateWordHeadersFooterstranslateWordInExcludeHighlightModetranslateWordInExcludeStyleModewordExcludedColorswordFontColorsMaxIgnoranceThresholdwordFontColorsMinIgnoranceThresholdwordHighlightColors