Поделиться через

Word.Interfaces.FontData interface

Пакет:
word

Интерфейс, описывающий данные, возвращаемые путем вызова font.toJSON().

Свойства

allCaps

Указывает, отформатирован ли шрифт как все прописные буквы, в результате чего строчные буквы отображаются как прописные буквы. Возможны следующие значения.

  • true : весь текст имеет атрибут All Caps .

  • false : ни один из текста не имеет атрибута All Caps .

  • null : возвращается, если некоторые (но не все) текста имеют атрибут All Caps .
bold

Указывает, выделен ли шрифт полужирным шрифтом. true Значение , если шрифт выделен полужирным шрифтом, в противном случае — falseзначение .
boldBidirectional

Указывает, будет ли шрифт отформатирован как полужирный в документе языка справа налево. Возможны следующие значения.

  • true : весь текст выделен полужирным шрифтом.

  • false : текст не выделен полужирным шрифтом.

  • null : возвращается, если некоторые( но не все) текста выделены полужирным шрифтом.
borders

BorderUniversalCollection Возвращает объект , представляющий все границы шрифта.
color

Задает цвет шрифта. Можно указать значение в формате "#RRGGBB" или в имени цвета.
colorIndex

Задает ColorIndex значение, представляющее цвет шрифта.
colorIndexBidirectional

Задает цвет объекта в документе Font справа налево.
contextualAlternates

Указывает, включены ли контекстные альтернативные варианты для шрифта.
diacriticColor

Указывает цвет, используемый для диакритических элементов объекта Font . Можно указать значение в формате "#RRGGBB".
disableCharacterSpaceGrid

Указывает, игнорирует ли microsoft Word количество символов в строке для соответствующего Font объекта.
doubleStrikeThrough

Указывает, имеет ли шрифт двойную зачеркивку. true Значение , если шрифт отформатирован как текст с двойной зачеркивной, в противном случае — falseзначение .
emboss

Указывает, отформатирован ли шрифт как рельефный. Возможны следующие значения.

  • true : весь текст вытянутый.

  • false : ни один текст не вытянутый.

  • null : возвращается, если некоторые( но не все) текста вытянуты.
emphasisMark

Задает EmphasisMark значение, представляющее знак подчеркивания для символа или указанной строки символов.
engrave

Указывает, отформатирован ли шрифт как выгравированный. Возможны следующие значения.

  • true : весь текст выгравирован.

  • false : ни один текст не выгравирован.

  • null : возвращается, если выгравированы некоторые , но не все фрагменты текста.
fill

FillFormat Возвращает объект, содержащий свойства форматирования заливки для шрифта, используемого диапазоном текста.
glow

GlowFormat Возвращает объект , представляющий форматирование свечения для шрифта, используемого диапазоном текста.
hidden

Указывает, помечен ли шрифт как скрытый. true Значение , если шрифт отформатирован как скрытый текст, в противном случае — falseзначение .
highlightColor

Задает цвет выделения. Чтобы задать его, используйте значение в формате "#RRGGBB" или в имени цвета. Чтобы удалить цвет выделения, задайте для него значение null. Возвращаемый цвет выделения может быть в формате "#RRGGBB", пустой строкой для смешанных цветов выделения или null без цвета выделения. Примечание. В Office для windows Desktop доступны только цвета выделения по умолчанию. Это "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray" и "Black". При запуске надстройки в Office для windows Desktop любой другой цвет преобразуется в ближайший цвет при применении к шрифту.
italic

Указывает, является ли шрифт курсивом. true Значение , если шрифт курсивом, в противном случае — falseзначение .
italicBidirectional

Указывает, является ли шрифт курсивом в языковом документе справа налево. Возможны следующие значения.

  • true : весь текст курсивом.

  • false : ни один текст не курсивирован.

  • null : возвращается, если некоторые( но не все) текста курсивом.
kerning

Указывает минимальный размер шрифта, для которого microsoft Word будет автоматически настраивать кернинг.
ligature

Задает параметр лигатуры для Font объекта .
line

LineFormat Возвращает объект , задающий форматирование для строки.
name

Задает имя шрифта.
nameAscii

Задает шрифт, используемый для латинского текста (символы с кодами символов от 0 (нуль) до 127).
nameBidirectional

Указывает имя шрифта в документе языка справа налево.
nameFarEast

Задает имя шрифта Восточной Азии.
nameOther

Задает шрифт, используемый для символов с кодами от 128 до 255.
numberForm

Задает параметр номерной формы для шрифта OpenType.
numberSpacing

Задает параметр числовых интервалов для шрифта.
outline

Указывает, отформатирован ли шрифт в виде контура. Возможны следующие значения.

  • true : весь текст выделен.

  • false : текст не выделен.

  • null : возвращается, если выделены некоторые , но не все фрагменты текста.
position

Указывает положение текста (в точках) относительно базовой строки.
reflection

ReflectionFormat Возвращает объект , представляющий форматирование отражения для фигуры.
scaling

Указывает процент масштабирования, применяемый к шрифту.
shadow

Указывает, будет ли шрифт отформатирован как тень. Возможны следующие значения.

  • true : весь текст затенен.

  • false : текст не затенен.

  • null : возвращается, если некоторые ( но не все) текста затеняются.
size

Задает размер шрифта в точках.
sizeBidirectional

Задает размер шрифта в точках для текста справа налево.
smallCaps

Указывает, отформатирован ли шрифт в виде небольших заглавных букв, в результате чего строчные буквы отображаются в виде небольших прописных букв. Возможны следующие значения.

  • true : весь текст имеет атрибут Small Caps .

  • false : ни в одном тексте нет атрибута Small Caps .

  • null : возвращается, если некоторые ( но не все) текста имеют атрибут Small Caps .
spacing

Задает интервал между символами.
strikeThrough

Указывает, имеет ли шрифт зачеркивку. true Значение , если шрифт отформатирован как зачеркнутый текст, в противном случае — falseзначение .
stylisticSet

Задает стилистический набор для шрифта.
subscript

Указывает, является ли шрифт подстрочным индексом. true Значение , если шрифт отформатирован как подстрочный, в противном случае — falseзначение .
superscript

Указывает, является ли шрифт надстрочным. true Значение , если шрифт отформатирован как надстрочный, в противном случае — falseзначение .
textColor

ColorFormat Возвращает объект , представляющий цвет шрифта.
textShadow

ShadowFormat Возвращает объект , указывающий форматирование тени для шрифта.
threeDimensionalFormat

ThreeDimensionalFormat Возвращает объект, содержащий 3-мерные (трехмерные) свойства форматирования для шрифта.
underline

Указывает тип подчеркивания шрифта. none Значение , если шрифт не подчеркнут.
underlineColor

Задает цвет подчеркивания для Font объекта . Можно указать значение в формате "#RRGGBB".

Сведения о свойстве

allCaps

Указывает, отформатирован ли шрифт как все прописные буквы, в результате чего строчные буквы отображаются как прописные буквы. Возможны следующие значения.

  • true : весь текст имеет атрибут All Caps .

  • false : ни один из текста не имеет атрибута All Caps .

  • null : возвращается, если некоторые (но не все) текста имеют атрибут All Caps .

allCaps?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

bold

Указывает, выделен ли шрифт полужирным шрифтом. true Значение , если шрифт выделен полужирным шрифтом, в противном случае — falseзначение .

bold?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

boldBidirectional

Указывает, будет ли шрифт отформатирован как полужирный в документе языка справа налево. Возможны следующие значения.

  • true : весь текст выделен полужирным шрифтом.

  • false : текст не выделен полужирным шрифтом.

  • null : возвращается, если некоторые( но не все) текста выделены полужирным шрифтом.

boldBidirectional?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

borders

BorderUniversalCollection Возвращает объект , представляющий все границы шрифта.

borders?: Word.Interfaces.BorderUniversalData[];

Значение свойства

Word.Interfaces.BorderUniversalData[]

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

color

Задает цвет шрифта. Можно указать значение в формате "#RRGGBB" или в имени цвета.

color?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApi 1.1 ]

colorIndex

Задает ColorIndex значение, представляющее цвет шрифта.

colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Значение свойства

Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

colorIndexBidirectional

Задает цвет объекта в документе Font справа налево.

colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Значение свойства

Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

contextualAlternates

Указывает, включены ли контекстные альтернативные варианты для шрифта.

contextualAlternates?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

diacriticColor

Указывает цвет, используемый для диакритических элементов объекта Font . Можно указать значение в формате "#RRGGBB".

diacriticColor?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

disableCharacterSpaceGrid

Указывает, игнорирует ли microsoft Word количество символов в строке для соответствующего Font объекта.

disableCharacterSpaceGrid?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

doubleStrikeThrough

Указывает, имеет ли шрифт двойную зачеркивку. true Значение , если шрифт отформатирован как текст с двойной зачеркивной, в противном случае — falseзначение .

doubleStrikeThrough?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

emboss

Указывает, отформатирован ли шрифт как рельефный. Возможны следующие значения.

  • true : весь текст вытянутый.

  • false : ни один текст не вытянутый.

  • null : возвращается, если некоторые( но не все) текста вытянуты.

emboss?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

emphasisMark

Задает EmphasisMark значение, представляющее знак подчеркивания для символа или указанной строки символов.

emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";

Значение свойства

Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

engrave

Указывает, отформатирован ли шрифт как выгравированный. Возможны следующие значения.

  • true : весь текст выгравирован.

  • false : ни один текст не выгравирован.

  • null : возвращается, если выгравированы некоторые , но не все фрагменты текста.

engrave?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

fill

FillFormat Возвращает объект, содержащий свойства форматирования заливки для шрифта, используемого диапазоном текста.

fill?: Word.Interfaces.FillFormatData;

Значение свойства

Word.Interfaces.FillFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

glow

GlowFormat Возвращает объект , представляющий форматирование свечения для шрифта, используемого диапазоном текста.

glow?: Word.Interfaces.GlowFormatData;

Значение свойства

Word.Interfaces.GlowFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

hidden

Указывает, помечен ли шрифт как скрытый. true Значение , если шрифт отформатирован как скрытый текст, в противном случае — falseзначение .

hidden?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

highlightColor

Задает цвет выделения. Чтобы задать его, используйте значение в формате "#RRGGBB" или в имени цвета. Чтобы удалить цвет выделения, задайте для него значение null. Возвращаемый цвет выделения может быть в формате "#RRGGBB", пустой строкой для смешанных цветов выделения или null без цвета выделения. Примечание. В Office для windows Desktop доступны только цвета выделения по умолчанию. Это "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray" и "Black". При запуске надстройки в Office для windows Desktop любой другой цвет преобразуется в ближайший цвет при применении к шрифту.

highlightColor?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApi 1.1 ]

italic

Указывает, является ли шрифт курсивом. true Значение , если шрифт курсивом, в противном случае — falseзначение .

italic?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

italicBidirectional

Указывает, является ли шрифт курсивом в языковом документе справа налево. Возможны следующие значения.

  • true : весь текст курсивом.

  • false : ни один текст не курсивирован.

  • null : возвращается, если некоторые( но не все) текста курсивом.

italicBidirectional?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

kerning

Указывает минимальный размер шрифта, для которого microsoft Word будет автоматически настраивать кернинг.

kerning?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

ligature

Задает параметр лигатуры для Font объекта .

ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All";

Значение свойства

Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

line

LineFormat Возвращает объект , задающий форматирование для строки.

line?: Word.Interfaces.LineFormatData;

Значение свойства

Word.Interfaces.LineFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

name

Задает имя шрифта.

name?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApi 1.1 ]

nameAscii

Задает шрифт, используемый для латинского текста (символы с кодами символов от 0 (нуль) до 127).

nameAscii?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

nameBidirectional

Указывает имя шрифта в документе языка справа налево.

nameBidirectional?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

nameFarEast

Задает имя шрифта Восточной Азии.

nameFarEast?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

nameOther

Задает шрифт, используемый для символов с кодами от 128 до 255.

nameOther?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

numberForm

Задает параметр номерной формы для шрифта OpenType.

numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle";

Значение свойства

Word.NumberForm | "Default" | "Lining" | "OldStyle"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

numberSpacing

Задает параметр числовых интервалов для шрифта.

numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular";

Значение свойства

Word.NumberSpacing | "Default" | "Proportional" | "Tabular"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

outline

Указывает, отформатирован ли шрифт в виде контура. Возможны следующие значения.

  • true : весь текст выделен.

  • false : текст не выделен.

  • null : возвращается, если выделены некоторые , но не все фрагменты текста.

outline?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

position

Указывает положение текста (в точках) относительно базовой строки.

position?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

reflection

ReflectionFormat Возвращает объект , представляющий форматирование отражения для фигуры.

reflection?: Word.Interfaces.ReflectionFormatData;

Значение свойства

Word.Interfaces.ReflectionFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

scaling

Указывает процент масштабирования, применяемый к шрифту.

scaling?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

shadow

Указывает, будет ли шрифт отформатирован как тень. Возможны следующие значения.

  • true : весь текст затенен.

  • false : текст не затенен.

  • null : возвращается, если некоторые ( но не все) текста затеняются.

shadow?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

size

Задает размер шрифта в точках.

size?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApi 1.1 ]

sizeBidirectional

Задает размер шрифта в точках для текста справа налево.

sizeBidirectional?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

smallCaps

Указывает, отформатирован ли шрифт в виде небольших заглавных букв, в результате чего строчные буквы отображаются в виде небольших прописных букв. Возможны следующие значения.

  • true : весь текст имеет атрибут Small Caps .

  • false : ни в одном тексте нет атрибута Small Caps .

  • null : возвращается, если некоторые ( но не все) текста имеют атрибут Small Caps .

smallCaps?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

spacing

Задает интервал между символами.

spacing?: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

strikeThrough

Указывает, имеет ли шрифт зачеркивку. true Значение , если шрифт отформатирован как зачеркнутый текст, в противном случае — falseзначение .

strikeThrough?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

stylisticSet

Задает стилистический набор для шрифта.

stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20";

Значение свойства

Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

subscript

Указывает, является ли шрифт подстрочным индексом. true Значение , если шрифт отформатирован как подстрочный, в противном случае — falseзначение .

subscript?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

superscript

Указывает, является ли шрифт надстрочным. true Значение , если шрифт отформатирован как надстрочный, в противном случае — falseзначение .

superscript?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

textColor

ColorFormat Возвращает объект , представляющий цвет шрифта.

textColor?: Word.Interfaces.ColorFormatData;

Значение свойства

Word.Interfaces.ColorFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

textShadow

ShadowFormat Возвращает объект , указывающий форматирование тени для шрифта.

textShadow?: Word.Interfaces.ShadowFormatData;

Значение свойства

Word.Interfaces.ShadowFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

threeDimensionalFormat

ThreeDimensionalFormat Возвращает объект, содержащий 3-мерные (трехмерные) свойства форматирования для шрифта.

threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData;

Значение свойства

Word.Interfaces.ThreeDimensionalFormatData

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

underline

Указывает тип подчеркивания шрифта. none Значение , если шрифт не подчеркнут.

underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Значение свойства

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

Комментарии

[ Набор API: WordApi 1.1 ]

underlineColor

Задает цвет подчеркивания для Font объекта . Можно указать значение в формате "#RRGGBB".

underlineColor?: string;

Значение свойства

string

Комментарии

[ Набор API: WordApiDesktop 1.3 ]