Word.Shape class
ヘッダー、フッター、またはドキュメント本文の図形を表します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。
- Extends
注釈
[ API set: WordApiDesktop 1.2 ]
プロパティ
allow |
特定の図形が他の図形と重なることができるかどうかを指定します。 |
alt |
図形に関連付けられている代替テキストを表す文字列を指定します。 |
body | 図形の body オブジェクトを表します。 テキスト ボックスと幾何学的図形にのみ適用されます。 |
canvas | 図形に関連付けられているキャンバスを取得します。
|
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
fill | 図形の塗りつぶしの書式設定を返します。 |
geometric |
図形の幾何学的図形の種類。 幾何学的図形でない場合は null になります。 |
height | 図形の高さ (ポイント単位)。 |
height |
垂直方向の相対的なサイズに対する図形の高さの割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。 |
id | 図形識別子を表す整数を取得します。 |
is |
この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。 |
left | 図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。 |
left |
図形の左側から水平方向の相対位置に対する割合としての相対左位置については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。 |
lock |
この図形の縦横比がロックされているかどうかを指定します。 |
name | 図形の名前。 |
parent |
この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。 |
parent |
この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。 |
relative |
図形の相対的な水平位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。 |
relative |
図形の相対的な水平サイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。 |
relative |
図形の相対的な垂直位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。 |
relative |
図形の相対的な垂直サイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。 |
rotation | 図形の回転を度単位で指定します。 Canvas 図形には適用されません。 |
shape |
図形に関連付けられている図形グループを取得します。
|
text |
図形のテキスト フレーム オブジェクトを取得します。 |
text |
図形のテキスト折り返し書式を返します。 |
top | 図形の上端から垂直方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。 |
top |
図形の上端から垂直方向の相対位置までのパーセンテージとしての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。 |
type | 図形の種類を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。 |
visible | 図形を表示するかどうかを指定します。 インライン図形には適用されません。 |
width | 図形の幅をポイント単位で指定します。 |
width |
水平方向の相対サイズに対する図形の幅の割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。 |
メソッド
delete() | 図形とその内容を削除します。 |
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
move |
図形をポイント数だけ水平方向に移動します。 |
move |
図形をポイント数だけ垂直方向に移動します。 |
scale |
指定した係数分だけ図形の高さを変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。 |
scale |
指定した係数分だけ図形の高さを変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。 |
scale |
指定した係数分だけ図形の幅を変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。 |
scale |
指定した係数分だけ図形の幅を変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。 |
select(select |
図形を選択します。 |
set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
toJSON() | API オブジェクトが |
track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
allowOverlap
特定の図形が他の図形と重なることができるかどうかを指定します。
allowOverlap: boolean;
プロパティ値
boolean
注釈
altTextDescription
図形に関連付けられている代替テキストを表す文字列を指定します。
altTextDescription: string;
プロパティ値
string
注釈
body
図形の body オブジェクトを表します。 テキスト ボックスと幾何学的図形にのみ適用されます。
readonly body: Word.Body;
プロパティ値
注釈
canvas
図形に関連付けられているキャンバスを取得します。
isNullObject
プロパティが true
に設定されているオブジェクトは、図形の種類が "Canvas" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
readonly canvas: Word.Canvas;
プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
fill
図形の塗りつぶしの書式設定を返します。
readonly fill: Word.ShapeFill;
プロパティ値
注釈
geometricShapeType
図形の幾何学的図形の種類。 幾何学的図形でない場合は null になります。
geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
プロパティ値
Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"
注釈
height
heightRelative
垂直方向の相対的なサイズに対する図形の高さの割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。
heightRelative: number;
プロパティ値
number
注釈
id
isChild
この図形がグループ図形またはキャンバス図形の子であるかどうかを確認します。
readonly isChild: boolean;
プロパティ値
boolean
注釈
left
図形の左側から水平方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
left: number;
プロパティ値
number
注釈
leftRelative
図形の左側から水平方向の相対位置に対する割合としての相対左位置については、「Word」を参照してください。RelativeHorizontalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。
leftRelative: number;
プロパティ値
number
注釈
lockAspectRatio
この図形の縦横比がロックされているかどうかを指定します。
lockAspectRatio: boolean;
プロパティ値
boolean
注釈
name
parentCanvas
この子図形の最上位の親キャンバス図形を取得します。 キャンバスの子図形でない場合は null になります。
readonly parentCanvas: Word.Shape;
プロパティ値
注釈
parentGroup
この子図形の最上位の親グループ図形を取得します。 グループの子図形でない場合は null になります。
readonly parentGroup: Word.Shape;
プロパティ値
注釈
relativeHorizontalPosition
図形の相対的な水平位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeHorizontalSize
図形の相対的な水平サイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeVerticalPosition
図形の相対的な垂直位置。 インライン図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeVerticalPosition。
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
relativeVerticalSize
図形の相対的な垂直サイズ。 インライン図形または子図形の場合は、設定できません。 詳細については、「Word」を参照してください。RelativeHorizontalPosition。
relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
プロパティ値
Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
注釈
rotation
図形の回転を度単位で指定します。 Canvas 図形には適用されません。
rotation: number;
プロパティ値
number
注釈
shapeGroup
図形に関連付けられている図形グループを取得します。
isNullObject
プロパティが true
に設定されているオブジェクトは、図形の種類が "GroupShape" でない場合に返されます。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
readonly shapeGroup: Word.ShapeGroup;
プロパティ値
注釈
textFrame
図形のテキスト フレーム オブジェクトを取得します。
readonly textFrame: Word.TextFrame;
プロパティ値
注釈
textWrap
図形のテキスト折り返し書式を返します。
readonly textWrap: Word.ShapeTextWrap;
プロパティ値
注釈
top
図形の上端から垂直方向の相対位置までの距離 (ポイント単位) については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形の場合、0 が返され、設定できません。 キャンバスまたはグループ内の子図形の場合、左上隅を基準にしています。
top: number;
プロパティ値
number
注釈
topRelative
図形の上端から垂直方向の相対位置までのパーセンテージとしての相対的な上端の位置については、「Word」を参照してください。RelativeVerticalPosition。 インライン図形または子図形の場合、0 が返され、設定できません。
topRelative: number;
プロパティ値
number
注釈
type
図形の種類を取得します。 現在、サポートされている図形は、テキスト ボックス、幾何学的図形、グループ、図、キャンバスのみです。
readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas";
プロパティ値
Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"
注釈
visible
図形を表示するかどうかを指定します。 インライン図形には適用されません。
visible: boolean;
プロパティ値
boolean
注釈
width
widthRelative
水平方向の相対サイズに対する図形の幅の割合については、「Word」を参照してください。RelativeSize。 インライン図形または子図形の場合は、設定できません。
widthRelative: number;
プロパティ値
number
注釈
メソッドの詳細
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(options?: Word.Interfaces.ShapeLoadOptions): Word.Shape;
パラメーター
- options
- Word.Interfaces.ShapeLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.Shape;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.Shape;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand
は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
moveHorizontally(distance)
図形をポイント数だけ水平方向に移動します。
moveHorizontally(distance: number): void;
パラメーター
- distance
-
number
必須です。 図形の水平方向の移動量をポイント単位で指定します。 正の値を使用して図形を右に移動します。 負の値を使用して図形を左に移動します。
戻り値
void
注釈
moveVertically(distance)
図形をポイント数だけ垂直方向に移動します。
moveVertically(distance: number): void;
パラメーター
- distance
-
number
必須です。 図形を垂直にどのくらい移動するかをポイント単位で指定します。 図形を上に移動するには、正の値を使用します。 負の値を使用して図形を下に移動します。
戻り値
void
注釈
scaleHeight(scaleFactor, scaleType, scaleFrom)
指定した係数分だけ図形の高さを変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。
scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;
パラメーター
- scaleFactor
-
number
現在の高さと変更後の高さの比率、または元の高さと変更後の高さの比率を指定します。
- scaleType
- Word.ShapeScaleType
図形を元のサイズと現在のサイズのどちらを基準にスケーリングするかを指定します。 元のサイズ スケーリング オプションは、イメージに対してのみ機能します。
- scaleFrom
- Word.ShapeScaleFrom
省略可能。 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。 省略すると、図形の左上隅がその位置を保持することを表します。
戻り値
void
注釈
scaleHeight(scaleFactor, scaleTypeString, scaleFromString)
指定した係数分だけ図形の高さを変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。
scaleHeight(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
パラメーター
- scaleFactor
-
number
現在の高さと変更後の高さの比率、または元の高さと変更後の高さの比率を指定します。
- scaleTypeString
-
"CurrentSize" | "OriginalSize"
図形を元のサイズと現在のサイズのどちらを基準にスケーリングするかを指定します。 元のサイズ スケーリング オプションは、イメージに対してのみ機能します。
- scaleFromString
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
省略可能。 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。 省略すると、図形の左上隅がその位置を保持することを表します。
戻り値
void
注釈
scaleWidth(scaleFactor, scaleType, scaleFrom)
指定した係数分だけ図形の幅を変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。
scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void;
パラメーター
- scaleFactor
-
number
現在の幅と変更後の幅の比率、または元の幅と変更後の幅の比率を指定します。
- scaleType
- Word.ShapeScaleType
図形を元のサイズと現在のサイズのどちらを基準にスケーリングするかを指定します。 元のサイズ スケーリング オプションは、イメージに対してのみ機能します。
- scaleFrom
- Word.ShapeScaleFrom
省略可能。 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。 省略すると、図形の左上隅がその位置を保持することを表します。
戻り値
void
注釈
scaleWidth(scaleFactor, scaleTypeString, scaleFromString)
指定した係数分だけ図形の幅を変更します。 画像の場合は、図形を元のサイズに対して拡大または縮小するのか、現在のサイズに対して拡大または縮小するのかを指定できます。 画像以外の図形の場合は、常に現在の高さに対して拡大または縮小されます。
scaleWidth(scaleFactor: number, scaleTypeString: "CurrentSize" | "OriginalSize", scaleFromString?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void;
パラメーター
- scaleFactor
-
number
現在の幅と変更後の幅の比率、または元の幅と変更後の幅の比率を指定します。
- scaleTypeString
-
"CurrentSize" | "OriginalSize"
図形を元のサイズと現在のサイズのどちらを基準にスケーリングするかを指定します。 元のサイズ スケーリング オプションは、イメージに対してのみ機能します。
- scaleFromString
-
"ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
省略可能。 図形を拡大縮小する場合、図形の位置を保持する部分を指定します。 省略すると、図形の左上隅がその位置を保持することを表します。
戻り値
void
注釈
select(selectMultipleShapes)
図形を選択します。
select(selectMultipleShapes?: boolean): void;
パラメーター
- selectMultipleShapes
-
boolean
省略可能。 複数の浮動図形を選択するかどうか。 既定値は false です。
戻り値
void
注釈
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;
パラメーター
- properties
- Word.Interfaces.ShapeUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.Shape): void;
パラメーター
- properties
- Word.Shape
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()
に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドをオーバーライドします。 (JSON.stringify
、それに渡されるオブジェクトの toJSON
メソッドを呼び出します)。元の Word.Shape
オブジェクトは API オブジェクトですが、 toJSON
メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.ShapeData
として型指定) を返します。
toJSON(): Word.Interfaces.ShapeData;
戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync
呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.Shape;
戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync()
を呼び出す必要があります。
untrack(): Word.Shape;
戻り値
Office Add-ins