Excel.ShapeLineFormat class

Ссылка

Пакет:: excel

Представляет форматирование линий для объекта фигуры. Для изображений и геометрических фигур форматирование линий представляет границу фигуры.

Extends: OfficeExtension.ClientObject

Свойства

color	Представляет цвет линии в цветовом формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dashStyle	Представляет тип линии фигуры. Возвращает, `null` если линия не видна или есть несогласованные стили дефисов. Дополнительные сведения см. в этой `Excel.ShapeLineDashStyle` статье.
style	Представляет тип линии фигуры. Возвращает, `null` если линия не видна или имеются несогласованные стили. Дополнительные сведения см. в этой `Excel.ShapeLineStyle` статье.
transparency	Представляет степень прозрачности указанной линии как значение от 0,0 (непрозрачная) до 1,0 (полностью прозрачная). Возвращает, `null` если фигура имеет несогласованную прозрачность.
visible	Указывает, отображается ли форматирование линий элемента фигуры. Возвращает, `null` когда фигура имеет несогласованную видимость.
weight	Представляет толщину линии (в пунктах). Возвращает, `null` если линия не видна или имеется несогласованный вес линии.

Методы

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

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

color

Представляет цвет линии в цветовом формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

color: string;

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

string

context

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

context: RequestContext;

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

Excel.RequestContext

dashStyle

Представляет тип линии фигуры. Возвращает, null если линия не видна или есть несогласованные стили дефисов. Дополнительные сведения см. в этой Excel.ShapeLineDashStyle статье.

dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

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

style

Представляет тип линии фигуры. Возвращает, null если линия не видна или имеются несогласованные стили. Дополнительные сведения см. в этой Excel.ShapeLineStyle статье.

style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

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

transparency

Представляет степень прозрачности указанной линии как значение от 0,0 (непрозрачная) до 1,0 (полностью прозрачная). Возвращает, null если фигура имеет несогласованную прозрачность.

transparency: number;

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

number

visible

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

visible: boolean;

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

boolean

weight

Представляет толщину линии (в пунктах). Возвращает, null если линия не видна или имеется несогласованный вес линии.

weight: number;

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

number

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

load(options)

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

load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;

Параметры

options: Excel.Interfaces.ShapeLineFormatLoadOptions

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

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

Excel.ShapeLineFormat

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.ShapeLineFormat

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.ShapeLineFormat

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.ShapeLineFormatUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ShapeLineFormat): void;

Параметры

properties: Excel.ShapeLineFormat

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ShapeLineFormatData;

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

Excel.Interfaces.ShapeLineFormatData

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

Excel.ShapeLineFormat class

Комментарии

Свойства

Методы

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

color

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

Комментарии

context

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

dashStyle

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

Комментарии

style

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

Комментарии

transparency

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

Комментарии

visible

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

Комментарии

weight

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь

Дополнительные ресурсы