PowerPoint.BulletFormat class

Пакет:: powerpoint

Представляет свойства форматирования маркеров текста, присоединенного к формату PowerPoint.ParagraphFormat.

Расширяет: OfficeExtension.ClientObject

Замечания

Примеры

// 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");
  await context.sync();

  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 . Возвращает значение `null` , если PowerPoint.TextRange содержит фрагменты текста с разными свойствами форматирования маркеров.
type	Указывает тип маркеров в абзаце. Дополнительные сведения см. в разделе PowerPoint.BulletType . Возвращает значение `null` , если PowerPoint.TextRange содержит фрагменты текста с разными свойствами форматирования маркеров.
visible	Указывает, отображаются ли маркеры в абзаце. Возвращает значение `null` , если PowerPoint.TextRange содержит фрагменты текста с разными значениями видимости маркеров.

Методика

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `PowerPoint.BulletFormat` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `PowerPoint.Interfaces.BulletFormatData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Подробнее

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Стоимость недвижимости

PowerPoint.RequestContext

style

Задает стиль маркеров в абзаце. Дополнительные сведения см. в статье PowerPoint.BulletStyle . Возвращает значение null , если PowerPoint.TextRange содержит фрагменты текста с разными свойствами форматирования маркеров.

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 . Возвращает значение null , если PowerPoint.TextRange содержит фрагменты текста с разными свойствами форматирования маркеров.

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

Стоимость недвижимости

Замечания

[ Набор API: PowerPointApi 1.10 ]

visible

Указывает, отображаются ли маркеры в абзаце. Возвращает значение null , если PowerPoint.TextRange содержит фрагменты текста с разными значениями видимости маркеров.

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()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.BulletFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.BulletFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): PowerPoint.Interfaces.BulletFormatData;

Возвращает

PowerPoint.Interfaces.BulletFormatData

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

PowerPoint.BulletFormat class

Замечания

Примеры

Свойства

Методика

Подробнее

context

Стоимость недвижимости

style

Стоимость недвижимости

Замечания

type

Стоимость недвижимости

Замечания

visible

Стоимость недвижимости

Замечания

Подробнее о методе

load(options)

Параметры

Возвращает

load(propertyNames)

Параметры

Возвращает

load(propertyNamesAndPaths)

Параметры

Возвращает

toJSON()

Возвращает

Обратная связь