Word.Interfaces.ShapeCollectionLoadOptions interface
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Wordのコレクションを格納します。図形オブジェクト。 現時点では、TextBox 図形のみがサポートされています。
注釈
[ API セット: WordApi BETA (プレビューのみ) ]
プロパティ
| $all | 読み込みオプションに |
| body | コレクション内の各項目について: 図形の body オブジェクトを表します。 TextBox 図形にのみ適用されます。 |
| height | コレクション内の各項目の場合: 図形の高さ (ポイント単位)。 |
| id | コレクション内の各項目について: 図形識別子を表す整数を取得します。 |
| left | コレクション内の各項目の場合: 図形の左側から水平方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。 |
| relative |
コレクション内の各項目の場合: 図形の相対的な水平位置。 浮動図形の場合は、設定できません。 |
| relative |
コレクション内の各項目の場合: 図形の相対的な垂直位置。 浮動図形の場合は、設定できません。 |
| top | コレクション内の各項目の場合: 図形の上端から垂直方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。 |
| type | コレクション内の各項目について: 図形の型を取得します。 現時点では、TextBox 図形のみがサポートされています。 |
| width | コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。 |
プロパティの詳細
$all
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
$all?: boolean;プロパティ値
boolean
body
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目について: 図形の body オブジェクトを表します。 TextBox 図形にのみ適用されます。
body?: Word.Interfaces.BodyLoadOptions;プロパティ値
注釈
height
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目の場合: 図形の高さ (ポイント単位)。
height?: boolean;プロパティ値
boolean
注釈
id
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目について: 図形識別子を表す整数を取得します。
id?: boolean;プロパティ値
boolean
注釈
left
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目の場合: 図形の左側から水平方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。
left?: boolean;プロパティ値
boolean
注釈
relativeHorizontalPosition
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目の場合: 図形の相対的な水平位置。 浮動図形の場合は、設定できません。
relativeHorizontalPosition?: boolean;プロパティ値
boolean
注釈
relativeVerticalPosition
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目の場合: 図形の相対的な垂直位置。 浮動図形の場合は、設定できません。
relativeVerticalPosition?: boolean;プロパティ値
boolean
注釈
top
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目の場合: 図形の上端から垂直方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。
top?: boolean;プロパティ値
boolean
注釈
type
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目について: 図形の型を取得します。 現時点では、TextBox 図形のみがサポートされています。
type?: boolean;プロパティ値
boolean
注釈
width
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コレクション内の各項目の場合: 図形の幅をポイント単位で指定します。
width?: boolean;プロパティ値
boolean
注釈
Office Add-ins