Word.Interfaces.ShapeData interface
shape.toJSON()
を呼び出すことによって返されるデータを記述するインターフェイス。
プロパティ
body | 図形の body オブジェクトを表します。 TextBox 図形にのみ適用されます。 |
height | 図形の高さ (ポイント単位)。 |
id | 図形識別子を表す整数を取得します。 |
left | 図形の左側から水平方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。 |
relative |
図形の相対的な水平位置。 浮動図形の場合は、設定できません。 |
relative |
図形の相対的な垂直位置。 浮動図形の場合は、設定できません。 |
top | 図形の上端から垂直方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。 |
type | 図形の種類を取得します。 現時点では、TextBox 図形のみがサポートされています。 |
width | 図形の幅をポイント単位で指定します。 |
プロパティの詳細
body
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の body オブジェクトを表します。 TextBox 図形にのみ適用されます。
body?: Word.Interfaces.BodyData;
プロパティ値
注釈
height
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の高さ (ポイント単位)。
height?: number;
プロパティ値
number
注釈
id
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形識別子を表す整数を取得します。
id?: number;
プロパティ値
number
注釈
left
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の左側から水平方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。
left?: number;
プロパティ値
number
注釈
relativeHorizontalPosition
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の相対的な水平位置。 浮動図形の場合は、設定できません。
relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeVerticalPosition
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の相対的な垂直位置。 浮動図形の場合は、設定できません。
relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
top
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の上端から垂直方向の相対位置までの距離をポイント単位で指定します。 浮動図形の場合、0 が返され、設定できません。
top?: number;
プロパティ値
number
注釈
type
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の種類を取得します。 現時点では、TextBox 図形のみがサポートされています。
type?: Word.ShapeType | "Unsupported" | "TextBox";
プロパティ値
Word.ShapeType | "Unsupported" | "TextBox"
注釈
width
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
図形の幅をポイント単位で指定します。
width?: number;
プロパティ値
number
注釈
Office Add-ins