PowerPoint.BulletFormat class

パッケージ:: powerpoint

PowerPoint.ParagraphFormat にアタッチされているテキストの箇条書き書式設定プロパティを表します。

Extends: OfficeExtension.ClientObject

注釈

使用元

PowerPoint.ParagraphFormat: bulletFormat

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");

  const parentTextFrame: PowerPoint.TextFrame = textRange.getParentTextFrame();
  const parentShape: PowerPoint.Shape = parentTextFrame.getParentShape();
  const parentSlide: PowerPoint.Slide = parentShape.getParentSlide();
  parentShape.load("id");
  parentSlide.load("id");
  await context.sync();

  console.log(`Selected text range found in parent shape with ID ${parentShape.id} on parentSlide with ID ${parentSlide.id}`);

  console.log("Font properties of selected text range:");
  console.log(`\tallCaps: ${textRange.font.allCaps}`);
  console.log(`\tbold: ${textRange.font.bold}`);
  console.log(`\tcolor: ${textRange.font.color}`);
  console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
  console.log(`\titalic: ${textRange.font.italic}`);
  console.log(`\tname: ${textRange.font.name}`);
  console.log(`\tsize: ${textRange.font.size}`);
  console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
  console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
  console.log(`\tsubscript: ${textRange.font.subscript}`);
  console.log(`\tsuperscript: ${textRange.font.superscript}`);
  console.log(`\tunderline: ${textRange.font.underline}`);

  console.log("Paragraph format properties of selected text range:");
  console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
  console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
style	段落内の箇条書きのスタイルを指定します。詳細については、PowerPoint.BulletStyle を参照してください。 PowerPoint.TextRange に異なる箇条書き書式設定プロパティを持つテキストフラグメントが含まれている場合は`null`を返します。
type	段落内の箇条書きの種類を指定します。詳細については、PowerPoint.BulletType を参照してください。 PowerPoint.TextRange に異なる箇条書き書式設定プロパティを持つテキストフラグメントが含まれている場合は`null`を返します。
visible	段落内の箇条書きを表示するかどうかを指定します。 PowerPoint.TextRange に、箇条書きの可視性の値が異なるテキストフラグメントが含まれている場合は `null` を返します。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `PowerPoint.BulletFormat` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `PowerPoint.Interfaces.BulletFormatData` と型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

style

段落内の箇条書きのスタイルを指定します。詳細については、PowerPoint.BulletStyle を参照してください。 PowerPoint.TextRange に異なる箇条書き書式設定プロパティを持つテキストフラグメントが含まれている場合はnullを返します。

style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;

プロパティ値

注釈

API セット: PowerPointApi 1.10

type

段落内の箇条書きの種類を指定します。詳細については、PowerPoint.BulletType を参照してください。 PowerPoint.TextRange に異なる箇条書き書式設定プロパティを持つテキストフラグメントが含まれている場合はnullを返します。

type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;

プロパティ値

注釈

API セット: PowerPointApi 1.10

visible

段落内の箇条書きを表示するかどうかを指定します。 PowerPoint.TextRange に、箇条書きの可視性の値が異なるテキストフラグメントが含まれている場合は null を返します。

visible: boolean | null;

プロパティ値

boolean | null

注釈

API セット: PowerPointApi 1.4

メソッドの詳細

load(options)

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

load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;

パラメーター

options: PowerPoint.Interfaces.BulletFormatLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

PowerPoint.BulletFormat

load(propertyNames)

load(propertyNames?: string | string[]): PowerPoint.BulletFormat;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

PowerPoint.BulletFormat

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.BulletFormat;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

PowerPoint.BulletFormat

toJSON()

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

toJSON(): PowerPoint.Interfaces.BulletFormatData;

返品

PowerPoint.Interfaces.BulletFormatData

フィードバック

このページはお役に立ちましたか?