Word.Interfaces.ShapeLoadOptions interface

ヘッダー、フッター、または文書本文の図形を表します。 現時点では、テキスト ボックス、幾何学的図形、グループ、画像、キャンバスの図形のみがサポートされています。

プロパティ

$all

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

allowOverlap

特定の図形が他の図形と重なることができるかどうかを指定します。

altTextDescription

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

body

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

canvas

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

fill

図形の塗りつぶしの書式設定を返します。

geometricShapeType

図形の幾何学的形状の種類を指定します。 幾何学的図形でない場合は null になります。

height

図形の高さをポイント単位で指定します。

heightRelative

相対的な垂直サイズに対する図形の高さの割合を指定します (つまり、 relativeVerticalSize プロパティ)。 インライン図形または子図形の場合は設定できません。

id

図形の識別子を表す整数を取得します。

isChild

この図形がグループ図形の子であるかキャンバス図形であるかを確認します。

left

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

leftRelative

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

lockAspectRatio

この図形の縦横比をロックするかどうかを指定します。

name

図形の名前を指定します。

parentCanvas

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

parentGroup

この子図形の最上位レベルの親グループ図形を取得します。 グループの子図形でない場合は null になります。

relativeHorizontalPosition

図形の相対的な水平位置を指定します。 インライン図形の場合は設定できません。 詳細については、Word を参照してください。RelativeHorizontalPosition

relativeHorizontalSize

図形の相対的な水平方向のサイズを指定します。 widthRelative プロパティと共に使用します。 インライン図形または子図形の場合は設定できません。

relativeVerticalPosition

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

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.address など) が読み込まれますが、ナビゲーション プロパティ ( Range.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

図形の幾何学的形状の種類を指定します。 幾何学的図形でない場合は 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

図形の識別子を表す整数を取得します。

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

この子図形の最上位レベルの親グループ図形を取得します。 グループの子図形でない場合は 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

図形の相対的な垂直位置を指定します。 インライン図形の場合は設定できません。 詳細については、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

図形に関連付けられている図形グループを取得します。 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