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

Word.Font class

  • Ссылка
Пакет:
word

Представляет шрифт.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Change the font color
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the font color of the current selection.
    selection.font.color = 'blue';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font color of the selection has been changed.');
});

Свойства

bold

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

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

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
doubleStrikeThrough

Указывает значение, указывающее, имеет ли шрифт двойную зачеркивку. Задайте значение true, чтобы использовать двойное зачеркивание, в противном случае задайте значение false.
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.
name

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

Задает значение, представляющее размер шрифта в пунктах.
strikeThrough

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

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

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

Задает значение, указывающее тип подчеркивания шрифта. "Нет", если шрифт не подчеркнут.

Методы

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Font объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.FontData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

bold

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

bold: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Bold format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to make the current selection bold.
    selection.font.bold = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection is now bold.');
});

color

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

color: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Change the font color
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the font color of the current selection.
    selection.font.color = 'blue';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font color of the selection has been changed.');
});

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Word.RequestContext

doubleStrikeThrough

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

doubleStrikeThrough: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

hidden

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

hidden: boolean;

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

boolean

Комментарии

[ Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

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 ]

Примеры

// Highlight selected text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to highlight the current selection.
    selection.font.highlightColor = '#FFFF00'; // Yellow

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection has been highlighted.');
});

italic

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

italic: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

name

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

name: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Change the font name
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font name.
    selection.font.name = 'Arial';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font name has changed.');
});

size

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

size: number;

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

number

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Change the font size
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font size.
    selection.font.size = 20;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font size has changed.');
});

strikeThrough

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

strikeThrough: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Strike format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to strikethrough the font of the current selection.
    selection.font.strikeThrough = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has a strikethrough.');
});

subscript

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

subscript: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

superscript

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

superscript: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

underline

Задает значение, указывающее тип подчеркивания шрифта. "Нет", если шрифт не подчеркнут.

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 ]

Примеры

// Underline format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to underline the current selection.
    selection.font.underline = Word.UnderlineType.single;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has an underline style.');
});

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.FontLoadOptions): Word.Font;

Параметры

options
Word.Interfaces.FontLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.Font

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.Font;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.Font

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Font;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.Font

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Word.Interfaces.FontUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.Font): void;

Параметры

properties
Word.Font

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Font объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.FontData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.FontData;

Возвращаемое значение

Word.Interfaces.FontData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.Font;

Возвращаемое значение

Word.Font

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.Font;

Возвращаемое значение

Word.Font