Word.Interfaces.ShapeCollectionLoadOptions interface

Содержит коллекцию Word. Придавайте форму объектам. В настоящее время поддерживаются только следующие фигуры: надписи, геометрические фигуры, группы, рисунки и холсты.

Комментарии

Набор API: WordApiDesktop 1.2

Используется

Свойства

$all

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

allowOverlap

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

altTextDescription

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

body

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Получает Body объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.

canvas

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Получает холст, связанный с фигурой. Объект со isNullObject свойством " true Нравится" будет возвращен, если тип фигуры отличается canvasот . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

fill

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

geometricShapeType

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

height

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

heightRelative

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

id

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

isChild

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

left

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

leftRelative

Для КАЖДОГО ЭЛЕМЕНТА в наборе: Указывает относительную левую позицию в процентах от левой стороны фигуры к относительной горизонтальной позиции (то есть relativeHorizontalalPosition свойству). Для встроенной или дочерней фигуры возвращается 0 и ее нельзя задать.

lockAspectRatio

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

name

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

parentCanvas

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

parentGroup

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

relativeHorizontalPosition

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

relativeHorizontalSize

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

relativeVerticalPosition

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

relativeVerticalSize

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

rotation

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

shapeGroup

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Получает группу фигур, связанную с фигурой. Объект со isNullObject свойством " true Нравится" будет возвращен, если тип фигуры отличается groupShapeот . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

textFrame

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

textWrap

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

top

Для КАЖДОГО ЭЛЕМЕНТА в наборе: Указывает расстояние в точках от верхнего края фигуры до относительного вертикального положения (то есть relativeVerticalPosition свойства). Для встроенной фигуры возвращается 0 и ее нельзя задать. Для дочерних фигур на холсте или в группе они определяются относительно левого верхнего угла.

topRelative

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

type

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

visible

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

width

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

widthRelative

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

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

$all

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

$all?: boolean;

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

boolean

allowOverlap

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

allowOverlap?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

altTextDescription

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

altTextDescription?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

body

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Получает Body объект фигуры. Применяется только к текстовым полям и геометрическим фигурам.

body?: Word.Interfaces.BodyLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

canvas

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Получает холст, связанный с фигурой. Объект со isNullObject свойством " true Нравится" будет возвращен, если тип фигуры отличается canvasот . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

canvas?: Word.Interfaces.CanvasLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

fill

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

fill?: Word.Interfaces.ShapeFillLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

geometricShapeType

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

geometricShapeType?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

height

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

height?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

heightRelative

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

heightRelative?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

id

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

id?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

isChild

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

isChild?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

left

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

left?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

leftRelative

Для КАЖДОГО ЭЛЕМЕНТА в наборе: Указывает относительную левую позицию в процентах от левой стороны фигуры к относительной горизонтальной позиции (то есть relativeHorizontalalPosition свойству). Для встроенной или дочерней фигуры возвращается 0 и ее нельзя задать.

leftRelative?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

lockAspectRatio

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

lockAspectRatio?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

name

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

name?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

parentCanvas

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

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

parentGroup

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

parentGroup?: Word.Interfaces.ShapeLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

relativeHorizontalPosition

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

relativeHorizontalPosition?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

relativeHorizontalSize

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

relativeHorizontalSize?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

relativeVerticalPosition

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

relativeVerticalPosition?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

relativeVerticalSize

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

relativeVerticalSize?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

rotation

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

rotation?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

shapeGroup

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: Получает группу фигур, связанную с фигурой. Объект со isNullObject свойством " true Нравится" будет возвращен, если тип фигуры отличается groupShapeот . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

textFrame

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

textFrame?: Word.Interfaces.TextFrameLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

textWrap

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

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

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

Комментарии

Набор API: WordApiDesktop 1.2

top

Для КАЖДОГО ЭЛЕМЕНТА в наборе: Указывает расстояние в точках от верхнего края фигуры до относительного вертикального положения (то есть relativeVerticalPosition свойства). Для встроенной фигуры возвращается 0 и ее нельзя задать. Для дочерних фигур на холсте или в группе они определяются относительно левого верхнего угла.

top?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

topRelative

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

topRelative?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

type

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

type?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

visible

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

visible?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

width

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

width?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2

widthRelative

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

widthRelative?: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.2