次の方法で共有

Word.Interfaces.ShapeCollectionLoadOptions interface

  • リファレンス
パッケージ:
word

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

注釈

[ API set: WordApiDesktop 1.2 ]

プロパティ

$all

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

コレクション内の各項目について: 特定の図形が他の図形と重なることができるかどうかを指定します。
altTextDescription

コレクション内の各項目の場合: 図形に関連付けられている代替テキストを表す文字列を指定します。
body

コレクション内の各項目について: 図形の body オブジェクトを表します。 テキスト ボックスと幾何学的図形にのみ適用されます。
canvas

コレクション内の各項目について: 図形に関連付けられているキャンバスを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "Canvas" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
fill

コレクション内の各項目の場合: 図形の塗りつぶしの書式設定を返します。
geometricShapeType

コレクション内の各項目の場合: 図形の幾何学的図形の種類。 幾何学的図形でない場合は null になります。
height

コレクション内の各項目の場合: 図形の高さ (ポイント単位)。
heightRelative

コレクション内の各項目: 図形の高さと垂直相対サイズの割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。
id

コレクション内の各項目について: 図形識別子を表す整数を取得します。
isChild

コレクション内の各項目について: この図形がグループ図形の子であるか、キャンバス図形であるかを確認します。
left

コレクション内の各項目: 図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
leftRelative

コレクション内の各項目: 図形の左側から水平方向の相対位置までの相対的な左の位置のパーセンテージについては、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。
lockAspectRatio

コレクション内の各項目の場合: この図形の縦横比がロックされているかどうかを指定します。
name

コレクション内の各項目の場合: 図形の名前。
parentCanvas

コレクション内の各項目について: この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。
parentGroup

コレクション内の各項目について: この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。
relativeHorizontalPosition

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

コレクション内の各項目の場合: 図形の相対的な水平方向のサイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeVerticalPosition

コレクション内の各項目の場合: 図形の相対的な垂直位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。
relativeVerticalSize

コレクション内の各項目の場合: 図形の相対的な垂直サイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
rotation

コレクション内の各項目の場合: 図形の回転を度単位で指定します。 Canvas 図形には適用されません。
shapeGroup

コレクション内の各項目について: 図形に関連付けられている図形グループを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "GroupShape" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
textFrame

コレクション内の各項目について: 図形のテキスト フレーム オブジェクトを取得します。
textWrap

コレクション内の各項目の場合: 図形のテキスト折り返し書式を返します。
top

コレクション内の各項目について: 図形の上端から垂直相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
topRelative

コレクション内の各項目: 図形の上端から垂直方向の相対位置までの割合としての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。
type

コレクション内の各項目について: 図形の型を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。
visible

コレクション内の各項目の場合: 図形が表示されるかどうかを指定します。 インライン図形には適用されません。
width

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

コレクション内の各項目: 図形の幅から水平方向の相対サイズに対する割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

allowOverlap

コレクション内の各項目について: 特定の図形が他の図形と重なることができるかどうかを指定します。

allowOverlap?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

altTextDescription

コレクション内の各項目の場合: 図形に関連付けられている代替テキストを表す文字列を指定します。

altTextDescription?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

body

コレクション内の各項目について: 図形の body オブジェクトを表します。 テキスト ボックスと幾何学的図形にのみ適用されます。

body?: Word.Interfaces.BodyLoadOptions;

プロパティ値

Word.Interfaces.BodyLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

canvas

コレクション内の各項目について: 図形に関連付けられているキャンバスを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "Canvas" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

canvas?: Word.Interfaces.CanvasLoadOptions;

プロパティ値

Word.Interfaces.CanvasLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

fill

コレクション内の各項目の場合: 図形の塗りつぶしの書式設定を返します。

fill?: Word.Interfaces.ShapeFillLoadOptions;

プロパティ値

Word.Interfaces.ShapeFillLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

geometricShapeType

コレクション内の各項目の場合: 図形の幾何学的図形の種類。 幾何学的図形でない場合は null になります。

geometricShapeType?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

height

コレクション内の各項目の場合: 図形の高さ (ポイント単位)。

height?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

heightRelative

コレクション内の各項目: 図形の高さと垂直相対サイズの割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。

heightRelative?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

id

コレクション内の各項目について: 図形識別子を表す整数を取得します。

id?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

isChild

コレクション内の各項目について: この図形がグループ図形の子であるか、キャンバス図形であるかを確認します。

isChild?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

left

コレクション内の各項目: 図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

left?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

leftRelative

コレクション内の各項目: 図形の左側から水平方向の相対位置までの相対的な左の位置のパーセンテージについては、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。

leftRelative?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

lockAspectRatio

コレクション内の各項目の場合: この図形の縦横比がロックされているかどうかを指定します。

lockAspectRatio?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

name

コレクション内の各項目の場合: 図形の名前。

name?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

parentCanvas

コレクション内の各項目について: この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

プロパティ値

Word.Interfaces.ShapeLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

parentGroup

コレクション内の各項目について: この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。

parentGroup?: Word.Interfaces.ShapeLoadOptions;

プロパティ値

Word.Interfaces.ShapeLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

relativeHorizontalPosition

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

relativeHorizontalPosition?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

relativeHorizontalSize

コレクション内の各項目の場合: 図形の相対的な水平方向のサイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。

relativeHorizontalSize?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

relativeVerticalPosition

コレクション内の各項目の場合: 図形の相対的な垂直位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。

relativeVerticalPosition?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

relativeVerticalSize

コレクション内の各項目の場合: 図形の相対的な垂直サイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。

relativeVerticalSize?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

rotation

コレクション内の各項目の場合: 図形の回転を度単位で指定します。 Canvas 図形には適用されません。

rotation?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

shapeGroup

コレクション内の各項目について: 図形に関連付けられている図形グループを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "GroupShape" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

プロパティ値

Word.Interfaces.ShapeGroupLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

textFrame

コレクション内の各項目について: 図形のテキスト フレーム オブジェクトを取得します。

textFrame?: Word.Interfaces.TextFrameLoadOptions;

プロパティ値

Word.Interfaces.TextFrameLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

textWrap

コレクション内の各項目の場合: 図形のテキスト折り返し書式を返します。

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

プロパティ値

Word.Interfaces.ShapeTextWrapLoadOptions

注釈

[ API set: WordApiDesktop 1.2 ]

top

コレクション内の各項目について: 図形の上端から垂直相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。

top?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

topRelative

コレクション内の各項目: 図形の上端から垂直方向の相対位置までの割合としての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。

topRelative?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

type

コレクション内の各項目について: 図形の型を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。

type?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

visible

コレクション内の各項目の場合: 図形が表示されるかどうかを指定します。 インライン図形には適用されません。

visible?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

width

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

width?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]

widthRelative

コレクション内の各項目: 図形の幅から水平方向の相対サイズに対する割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。

widthRelative?: boolean;

プロパティ値

boolean

注釈

[ API set: WordApiDesktop 1.2 ]