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


Excel.Interfaces.ShapeCollectionLoadOptions interface

Представляет коллекцию всех фигур на листе.

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

altTextDescription

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает замещающий текст описания объекта Shape .

altTextTitle

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает замещающий текст заголовка Shape для объекта.

connectionSiteCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает количество сайтов подключения на этой фигуре.

displayName

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает отображаемое имя фигуры. Только что созданная фигура имеет созданное имя, локализованное и не соответствующее ей name. В этом сценарии этот API можно использовать для получения имени, отображаемого в пользовательском интерфейсе.

fill

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форматирование заливки этой фигуры.

geometricShape

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает геометрическую фигуру, связанную с фигурой. Если тип фигуры отличается от GeometricShape, возникает ошибка.

geometricShapeType

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает тип геометрической фигуры этой геометрической фигуры. Дополнительные сведения см. в этой Excel.GeometricShapeType статье. Возвращает значение null , если тип фигуры не является "GeometryShape".

group

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает группу фигур, связанную с фигурой. Если тип фигуры отличается от GroupShape, возникает ошибка.

height

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает высоту фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

id

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает идентификатор фигуры.

image

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает изображение, связанное с фигурой. Если тип фигуры отличается от Image, возникает ошибка.

left

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от левой части фигуры до левой части листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.

level

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает уровень указанной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

line

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает линию, связанную с фигурой. Если тип фигуры отличается от Line, возникает ошибка.

lineFormat

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форматирование линий этой фигуры.

lockAspectRatio

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, заблокировано ли пропорции этой фигуры.

name

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает имя фигуры.

parentGroup

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает родительскую группу этой фигуры.

placement

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет способ присоединения объекта к ячейкам под ним.

rotation

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает поворот фигуры в градусах.

textFrame

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает объект текстового фрейма этой фигуры.

top

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от верхнего края фигуры до верхнего края листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.

type

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип этой фигуры. Дополнительные сведения см. в этой Excel.ShapeType статье.

visible

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, видна ли фигура.

width

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает ширину фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

zOrderPosition

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает положение указанной фигуры в z-порядке, при этом значение 0 представляет нижнюю часть стека заказов.

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

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

$all?: boolean;

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

boolean

altTextDescription

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает замещающий текст описания объекта Shape .

altTextDescription?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

altTextTitle

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает замещающий текст заголовка Shape для объекта.

altTextTitle?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

connectionSiteCount

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает количество сайтов подключения на этой фигуре.

connectionSiteCount?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

displayName

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает отображаемое имя фигуры. Только что созданная фигура имеет созданное имя, локализованное и не соответствующее ей name. В этом сценарии этот API можно использовать для получения имени, отображаемого в пользовательском интерфейсе.

displayName?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.15 ]

fill

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форматирование заливки этой фигуры.

fill?: Excel.Interfaces.ShapeFillLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

geometricShape

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает геометрическую фигуру, связанную с фигурой. Если тип фигуры отличается от GeometricShape, возникает ошибка.

geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

geometricShapeType

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает тип геометрической фигуры этой геометрической фигуры. Дополнительные сведения см. в этой Excel.GeometricShapeType статье. Возвращает значение null , если тип фигуры не является "GeometryShape".

geometricShapeType?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

group

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает группу фигур, связанную с фигурой. Если тип фигуры отличается от GroupShape, возникает ошибка.

group?: Excel.Interfaces.ShapeGroupLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

height

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает высоту фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

height?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

id

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает идентификатор фигуры.

id?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

image

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает изображение, связанное с фигурой. Если тип фигуры отличается от Image, возникает ошибка.

image?: Excel.Interfaces.ImageLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

left

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от левой части фигуры до левой части листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.

left?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

level

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает уровень указанной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

level?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

line

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает линию, связанную с фигурой. Если тип фигуры отличается от Line, возникает ошибка.

line?: Excel.Interfaces.LineLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

lineFormat

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает форматирование линий этой фигуры.

lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

lockAspectRatio

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, заблокировано ли пропорции этой фигуры.

lockAspectRatio?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

name

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает имя фигуры.

name?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

parentGroup

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает родительскую группу этой фигуры.

parentGroup?: Excel.Interfaces.ShapeLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

placement

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: представляет способ присоединения объекта к ячейкам под ним.

placement?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

rotation

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает поворот фигуры в градусах.

rotation?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

textFrame

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает объект текстового фрейма этой фигуры.

textFrame?: Excel.Interfaces.TextFrameLoadOptions;

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

top

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: расстояние в точках от верхнего края фигуры до верхнего края листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.

top?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

type

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип этой фигуры. Дополнительные сведения см. в этой Excel.ShapeType статье.

type?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

visible

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, видна ли фигура.

visible?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

width

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает ширину фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

width?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

zOrderPosition

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает положение указанной фигуры в z-порядке, при этом значение 0 представляет нижнюю часть стека заказов.

zOrderPosition?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]