Word.Border class

罫線の色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。

color: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Sets the bottom border color to red.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.color = "red";
  await context.sync();
});

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

context: RequestContext;

プロパティ値

境界線の位置を取得します。

readonly location: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";

プロパティ値

注釈

API セット: WordApiDesktop 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Gets the location of the border in its border collection.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);
  border.load("location");
  await context.sync();

  console.log(`Border location: ${border.location}`);
});

罫線の種類を指定します。

type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

プロパティ値

注釈

API セット: WordApiDesktop 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Sets the bottom border type to a dashed line.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.type = Word.BorderType.dashed;
  await context.sync();
});

境界線を表示するかどうかを指定します。

visible: boolean;

プロパティ値

注釈

API セット: WordApiDesktop 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Hides the bottom border.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.visible = false;
  await context.sync();
});

罫線の幅を指定します。

width: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

プロパティ値

注釈

API セット: WordApiDesktop 1.1

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Sets the bottom border width to 4.5 points.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);

  border.width = Word.BorderWidth.pt450;
  await context.sync();
});

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

load(options?: Word.Interfaces.BorderLoadOptions): Word.Border;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Word.Border): void;

パラメーター

返品

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

toJSON(): Word.Interfaces.BorderData;

返品

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Loads all scalar properties and returns them as a plain JavaScript object.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const border: Word.Border = style.borders.getByLocation(Word.BorderLocation.bottom);
  border.load("color, location, type, visible, width");
  await context.sync();

  console.log("Border properties:", border.toJSON());
});

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

track(): Word.Border;

返品

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

untrack(): Word.Border;

返品