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


Excel.ShapeFont class

Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта и цвет, для объекта фигуры TextRange .

Extends

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

bold

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

color

Представление цветового кода HTML для цвета текста (например, "#FF0000" представляет красный цвет). Возвращает значение null , если объект TextRange содержит фрагменты текста с разными цветами.

context

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

italic

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

name

Представляет имя шрифта (например, "Calibri"). Если текст является сложным или восточноазиатским языком, это соответствующее имя шрифта; в противном случае это латинское имя шрифта.

size

Представляет размер шрифта в пунктах (например, 11). Возвращает значение null , если объект TextRange содержит фрагменты текста с разными размерами шрифта.

underline

Тип подчеркивания, применяемый для шрифта. Возвращает значение null , если объект TextRange содержит фрагменты текста с разными стилями подчеркивания. Дополнительные сведения см. в этой Excel.ShapeFontUnderlineStyle статье.

Методы

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 метод переданного ему объекта.) В то время как исходный Excel.ShapeFont объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ShapeFontData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

bold

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

bold: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

color

Представление цветового кода HTML для цвета текста (например, "#FF0000" представляет красный цвет). Возвращает значение null , если объект TextRange содержит фрагменты текста с разными цветами.

color: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

context

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

context: RequestContext;

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

italic

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

italic: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

name

Представляет имя шрифта (например, "Calibri"). Если текст является сложным или восточноазиатским языком, это соответствующее имя шрифта; в противном случае это латинское имя шрифта.

name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

size

Представляет размер шрифта в пунктах (например, 11). Возвращает значение null , если объект TextRange содержит фрагменты текста с разными размерами шрифта.

size: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

underline

Тип подчеркивания, применяемый для шрифта. Возвращает значение null , если объект TextRange содержит фрагменты текста с разными стилями подчеркивания. Дополнительные сведения см. в этой Excel.ShapeFontUnderlineStyle статье.

underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";

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

Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

load(options)

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

load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;

Параметры

options
Excel.Interfaces.ShapeFontLoadOptions

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

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

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.ShapeFont;

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ShapeFont;

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.ShapeFontUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ShapeFont): void;

Параметры

properties
Excel.ShapeFont

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ShapeFontData;

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