Word.LineFormat class

パターン化された線の背景色を表す ColorFormat オブジェクトを取得します。

readonly backgroundColor: Word.ColorFormat;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

行の先頭の矢じりの長さを指定します。

beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

行の先頭の矢印のスタイルを指定します。

beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

行の先頭の矢じりの幅を指定します。

beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

線のダッシュ スタイルを指定します。

dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

線の終点の矢じりの長さを指定します。

endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

行の末尾の矢じりのスタイルを指定します。

endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

行の終わりの矢じりの幅を指定します。

endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

線の前景色を表す ColorFormat オブジェクトを取得します。

readonly foregroundColor: Word.ColorFormat;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

図形の内部に線を描画するかどうかを指定します。

insetPen: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

オブジェクト、またはオブジェクトに適用されている書式を表示するかどうかを指定します。

isVisible: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

線に適用するパターンを指定します。

pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

線の書式スタイルを指定します。

style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin";

プロパティ値

注釈

API セット: WordApiDesktop 1.3

線の透明度を、0.0 (不透明) から 1.0 (クリア) の値で指定します。

transparency: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

線の太さをポイント単位で指定します。

weight: number;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.LineFormat;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.LineFormat;

パラメーター

返品

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.LineFormat): void;

パラメーター

返品

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.LineFormat オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.LineFormatData と型指定) を返します。

toJSON(): Word.Interfaces.LineFormatData;

返品

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.LineFormat;

返品

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.LineFormat;

返品