Word.ParagraphFormat class

指定した段落の配置を指定します。

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

プロパティ値

注釈

API セット: WordAPI 1.5

例

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

// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to update its paragraph format.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.paragraphFormat.leftIndent = 30;
    style.paragraphFormat.alignment = Word.Alignment.centered;
    console.log(`Successfully the paragraph format of the '${styleName}' style.`);
  }
});

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

context: RequestContext;

プロパティ値

1 行目またはぶら下げインデントの値 (ポイント単位) を指定します。 最初の行のインデントを設定するのには正の値を使用し、ぶら下げインデントを設定するのには負の値を使用します。

firstLineIndent: number;

プロパティ値

注釈

API セット: WordAPI 1.5

Microsoft Word が文書の改ページ位置を変更するときに、指定された段落内のすべての行を同じページに残すかどうかを指定します。

keepTogether: boolean;

プロパティ値

注釈

API セット: WordAPI 1.5

Microsoft Word で文書の改ページ位置を変更するときに、指定した段落を、その後の段落と同じページに残すかどうかを指定します。

keepWithNext: boolean;

プロパティ値

注釈

API セット: WordAPI 1.5

左インデントを指定します。

leftIndent: number;

プロパティ値

注釈

API セット: WordAPI 1.5

例

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

// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
  const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
  if (styleName == "") {
    console.warn("Enter a style name to update its paragraph format.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.paragraphFormat.leftIndent = 30;
    style.paragraphFormat.alignment = Word.Alignment.centered;
    console.log(`Successfully the paragraph format of the '${styleName}' style.`);
  }
});

指定する段落の行間隔 (ポイント単位) を指定します。

lineSpacing: number;

プロパティ値

注釈

API セット: WordAPI 1.5

指定した段落の後の間隔 (グリッド線) を指定します。

lineUnitAfter: number;

プロパティ値

注釈

API セット: WordAPI 1.5

指定した段落の前の間隔 (グリッド線) を指定します。

lineUnitBefore: number;

プロパティ値

注釈

API セット: WordAPI 1.5

左右のインデントの幅が同じかどうかを指定します。

mirrorIndents: boolean;

プロパティ値

注釈

API セット: WordAPI 1.5

指定する段落のアウトライン レベルを指定します。

outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";

プロパティ値

注釈

API セット: WordAPI 1.5

指定された段落の右インデント (ポイント単位) を指定します。

rightIndent: number;

プロパティ値

注釈

API セット: WordAPI 1.5

指定した段落またはテキスト列の後の間隔をポイント単位で指定します。

spaceAfter: number;

プロパティ値

注釈

API セット: WordAPI 1.5

指定した段落の前の間隔をポイント単位で指定します。

spaceBefore: number;

プロパティ値

注釈

API セット: WordAPI 1.5

Microsoft Word によって文書の改ページ位置が変更されるときに、指定した段落の最初と最後の行を段落の残りの行と同じページに残すかどうかを指定します。

widowControl: boolean;

プロパティ値

注釈

API セット: WordAPI 1.5

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

load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Word.ParagraphFormat): void;

パラメーター

返品

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

toJSON(): Word.Interfaces.ParagraphFormatData;

返品

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

track(): Word.ParagraphFormat;

返品

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

untrack(): Word.ParagraphFormat;

返品