Word.BorderCollection class

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

context: RequestContext;

プロパティ値

内側の境界線の 24 ビット カラーを指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。

insideBorderColor: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.1

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

insideBorderType: 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

内側の境界線の幅を指定します。

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

プロパティ値

注釈

API セット: WordApiDesktop 1.1

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Word.Border[];

プロパティ値

外側の境界線の 24 ビット色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。

outsideBorderColor: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.1

例

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

// Sets the outside border color of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.outsideBorderColor = "#4472C4";
  await context.sync();

  console.log("Set the Sample Style outside border color to blue.");
});

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

outsideBorderType: 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/manage-styles.yaml

// Sets the outside border type of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.outsideBorderType = Word.BorderType.dashed;
  await context.sync();

  console.log("Set the Sample Style outside border type to dashed.");
});

外側の境界線の幅を指定します。

outsideBorderWidth: 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/manage-styles.yaml

// Sets the outside border width of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  const borderWidth: Word.BorderWidth = Word.BorderWidth.pt225;
  borders.outsideBorderWidth = borderWidth;
  await context.sync();

  console.log("Set the Sample Style outside border width to 2.25 points.");
});

指定した場所の境界線を取得します。

getByLocation(borderLocation: Word.BorderLocation.top | Word.BorderLocation.left | Word.BorderLocation.bottom | Word.BorderLocation.right | Word.BorderLocation.insideHorizontal | Word.BorderLocation.insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"): Word.Border;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.1

例

// 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 borders: Word.BorderCollection = style.borders;
  const border: Word.Border = borders.getByLocation(Word.BorderLocation.bottom);
  border.load("color, location, type, visible, width");
  await context.sync();

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

このコレクションの最初の境界線を取得します。 このコレクションが空の場合は、 ItemNotFound エラーをスローします。

getFirst(): Word.Border;

返品

注釈

API セット: WordApiDesktop 1.1

このコレクションの最初の境界線を取得します。 このコレクションが空の場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getFirstOrNullObject(): Word.Border;

返品

注釈

API セット: WordApiDesktop 1.1

コレクション内のインデックスによって Border オブジェクトを取得します。

getItem(index: number): Word.Border;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.1

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

load(options?: Word.Interfaces.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderCollection;

パラメーター

返品

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

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

パラメーター

返品

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BorderCollection;

パラメーター

返品

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

toJSON(): Word.Interfaces.BorderCollectionData;

返品

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

track(): Word.BorderCollection;

返品

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

untrack(): Word.BorderCollection;

返品