Word.Interfaces.ShapeCollectionLoadOptions interface

パッケージ:

word

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

プロパティ

$all	読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
body	コレクション内の各項目について: 図形の body オブジェクトを表します。 テキスト ボックスと幾何学的図形にのみ適用されます。
geometricShapeType	コレクション内の各項目の場合: 図形の幾何学的図形の種類。 幾何学的図形でない場合は null になります。
height	コレクション内の各項目の場合: 図形の高さ (ポイント単位)。
id	コレクション内の各項目について: 図形識別子を表す整数を取得します。
left	コレクション内の各項目: 図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形の場合、0 が返され、設定できません。
name	コレクション内の各項目の場合: 図形の名前。
relativeHorizontalPosition	コレクション内の各項目の場合: 図形の相対的な水平位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeVerticalPosition	コレクション内の各項目の場合: 図形の相対的な垂直位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。
shapeGroup	コレクション内の各項目について: 図形に関連付けられている図形グループを取得します。 isNullObject プロパティが true に設定されているオブジェクトは、図形の種類が "GroupShape" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
top	コレクション内の各項目について: 図形の上端から垂直相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形の場合、0 が返され、設定できません。
type	コレクション内の各項目について: 図形の型を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ化された図形、図のみです。
width	コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。

プロパティの詳細

$all

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

$all?: boolean;

プロパティ値

boolean

body

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

body?: Word.Interfaces.BodyLoadOptions;

プロパティ値

Word.Interfaces.BodyLoadOptions

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

geometricShapeType

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

geometricShapeType?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

height

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

height?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

id

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

left

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

left?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

name

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

relativeHorizontalPosition

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

relativeHorizontalPosition?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

relativeVerticalPosition

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

relativeVerticalPosition?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

shapeGroup

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

プロパティ値

Word.Interfaces.ShapeGroupLoadOptions

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

top

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

top?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

type

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

width

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

width?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]