Word.Interfaces.ShapeCollectionLoadOptions interface

Word のコレクションが含まれています。オブジェクトをシェイプします。 現時点では、テキスト ボックス、幾何学的図形、グループ、画像、キャンバスの図形のみがサポートされています。

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

allowOverlap

コレクション内の各項目の場合: 特定の図形が他の図形と重なってよいかどうかを指定します。

altTextDescription

For each ITEM in the collection: 図形に関連付けられている代替テキストを表す文字列を指定します。

body

For each ITEM in the collection: 図形の Body オブジェクトを取得します。 テキスト ボックスと幾何学的図形にのみ適用されます。

canvas

For each ITEM in the collection: 図形に関連付けられているキャンバスを取得します。 isNullObject プロパティが true に設定されたオブジェクトは、図形の種類が canvas でない場合に返されます。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

fill

For EACH ITEM in the collection: 図形の塗りつぶしの書式設定を返します。

geometricShapeType

コレクション内の各アイテムの場合: 図形の幾何学的形状の種類を指定します。 幾何学的図形でない場合は null になります。

height

コレクション内の各アイテムの場合: 図形の高さをポイント単位で指定します。

heightRelative

コレクション内の各アイテムの場合: 相対的な垂直サイズに対する図形の高さのパーセンテージ (つまり、 relativeVerticalSize プロパティ) を指定します。 インライン図形または子図形の場合は設定できません。

id

For each ITEM in the collection: 図形識別子を表す整数を取得します。

isChild

コレクション内の各アイテムの場合: この図形がグループ図形またはキャンバス図形の子であるかどうかをチェックします。

left

For each ITEM in the collection: 図形の左側から相対的な水平位置 (つまり、 relativeHorizontalPosition プロパティ) までの距離をポイント単位で指定します。 インライン図形の場合は 0 が返されるため、設定することはできません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

leftRelative

For each ITEM in the collection: 図形の左側から相対的な水平位置に対するパーセンテージで、相対左位置を指定します (つまり、 relativeHorizontalalPosition プロパティ)。 インライン図形または子図形の場合は 0 が返され、設定することはできません。

lockAspectRatio

For each ITEM in the collection: この図形の縦横比がロックされているかどうかを指定します。

name

For each ITEM in the collection: 図形の名前を指定します。

parentCanvas

For each ITEM in the collection: この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。

parentGroup

For each ITEM in the collection: この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。

relativeHorizontalPosition

コレクション内の各アイテムの場合: 図形の相対的な水平位置を指定します。 インライン図形の場合は設定できません。 詳細については、Word を参照してください。RelativeHorizontalPosition

relativeHorizontalSize

コレクション内の各アイテムの場合: 図形の相対的な水平サイズを指定します。 widthRelative プロパティと共に使用します。 インライン図形または子図形の場合は設定できません。

relativeVerticalPosition

For each ITEM in the collection: 図形の相対的な垂直位置を指定します。 インライン図形の場合は設定できません。 詳細については、Word を参照してください。RelativeVerticalPosition

relativeVerticalSize

コレクション内の各アイテムの場合: 図形の相対的な垂直サイズを指定します。 heightRelative プロパティと共に使用します。 インライン図形または子図形の場合は設定できません。

rotation

コレクション内の各アイテムの場合: 図形の回転を度単位で指定します。 キャンバス図形には適用されません。

shapeGroup

For each ITEM in the collection: 図形に関連付けられている図形グループを取得します。 isNullObject プロパティが true に設定されたオブジェクトは、図形の種類が groupShape でない場合に返されます。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

textFrame

For each ITEM in the collection: 図形の TextFrame オブジェクトを取得します。

textWrap

For each ITEM in the collection: 図形の文字列の折り返し書式設定を返します。

top

コレクション内の各アイテムの場合: 図形の上端から相対的な垂直位置 (つまり、 relativeVerticalPosition プロパティ) までの距離をポイント単位で指定します。 インライン図形の場合は 0 が返されるため、設定することはできません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

topRelative

コレクション内の各アイテムの場合: 図形の上端から相対的な垂直位置までのパーセンテージで相対的な最上位を指定します (つまり、 relativeVerticalPosition プロパティ)。 インライン図形または子図形の場合は 0 が返され、設定することはできません。

type

For each ITEM in the collection: 図形の種類を取得します。 現時点では、テキスト ボックス、幾何学的図形、グループ、画像、キャンバスの図形のみがサポートされています。

visible

For each ITEM in the collection: 図形が表示されるかどうかを指定します。 インライン図形には適用されません。

width

コレクション内の各アイテムの場合: 図形の幅をポイント単位で指定します。

widthRelative

コレクション内の各アイテムの場合: 相対的な水平サイズに対する図形の幅の割合 (つまり、 relativeHorizontalSize プロパティ) を指定します。 インライン図形または子図形の場合は設定できません。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

allowOverlap

コレクション内の各項目の場合: 特定の図形が他の図形と重なってよいかどうかを指定します。

allowOverlap?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

altTextDescription

For each ITEM in the collection: 図形に関連付けられている代替テキストを表す文字列を指定します。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

body

For each ITEM in the collection: 図形の Body オブジェクトを取得します。 テキスト ボックスと幾何学的図形にのみ適用されます。

body?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

canvas

For each ITEM in the collection: 図形に関連付けられているキャンバスを取得します。 isNullObject プロパティが true に設定されたオブジェクトは、図形の種類が canvas でない場合に返されます。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

canvas?: Word.Interfaces.CanvasLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

fill

For EACH ITEM in the collection: 図形の塗りつぶしの書式設定を返します。

fill?: Word.Interfaces.ShapeFillLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

geometricShapeType

コレクション内の各アイテムの場合: 図形の幾何学的形状の種類を指定します。 幾何学的図形でない場合は null になります。

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

For each ITEM in the collection: 図形識別子を表す整数を取得します。

id?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

isChild

コレクション内の各アイテムの場合: この図形がグループ図形またはキャンバス図形の子であるかどうかをチェックします。

isChild?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

left

For each ITEM in the collection: 図形の左側から相対的な水平位置 (つまり、 relativeHorizontalPosition プロパティ) までの距離をポイント単位で指定します。 インライン図形の場合は 0 が返されるため、設定することはできません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

left?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

leftRelative

For each ITEM in the collection: 図形の左側から相対的な水平位置に対するパーセンテージで、相対左位置を指定します (つまり、 relativeHorizontalalPosition プロパティ)。 インライン図形または子図形の場合は 0 が返され、設定することはできません。

leftRelative?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

lockAspectRatio

For each ITEM in the collection: この図形の縦横比がロックされているかどうかを指定します。

lockAspectRatio?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

name

For each ITEM in the collection: 図形の名前を指定します。

name?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

parentCanvas

For each ITEM in the collection: この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

parentGroup

For each ITEM in the collection: この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。

parentGroup?: Word.Interfaces.ShapeLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

relativeHorizontalPosition

コレクション内の各アイテムの場合: 図形の相対的な水平位置を指定します。 インライン図形の場合は設定できません。 詳細については、Word を参照してください。RelativeHorizontalPosition

relativeHorizontalPosition?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

relativeHorizontalSize

コレクション内の各アイテムの場合: 図形の相対的な水平サイズを指定します。 widthRelative プロパティと共に使用します。 インライン図形または子図形の場合は設定できません。

relativeHorizontalSize?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

relativeVerticalPosition

For each ITEM in the collection: 図形の相対的な垂直位置を指定します。 インライン図形の場合は設定できません。 詳細については、Word を参照してください。RelativeVerticalPosition

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

For each ITEM in the collection: 図形に関連付けられている図形グループを取得します。 isNullObject プロパティが true に設定されたオブジェクトは、図形の種類が groupShape でない場合に返されます。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

textFrame

For each ITEM in the collection: 図形の TextFrame オブジェクトを取得します。

textFrame?: Word.Interfaces.TextFrameLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.2

textWrap

For each ITEM in the collection: 図形の文字列の折り返し書式設定を返します。

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

For each ITEM in the collection: 図形の種類を取得します。 現時点では、テキスト ボックス、幾何学的図形、グループ、画像、キャンバスの図形のみがサポートされています。

type?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

visible

For each ITEM in the collection: 図形が表示されるかどうかを指定します。 インライン図形には適用されません。

visible?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

width

コレクション内の各アイテムの場合: 図形の幅をポイント単位で指定します。

width?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2

widthRelative

コレクション内の各アイテムの場合: 相対的な水平サイズに対する図形の幅の割合 (つまり、 relativeHorizontalSize プロパティ) を指定します。 インライン図形または子図形の場合は設定できません。

widthRelative?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.2