PowerPoint.ShapeFont class

Paquete:

powerpoint

Representa los atributos de fuente, como el nombre de fuente, el tamaño de fuente y el color, para el objeto TextRange de una forma.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

Propiedades

allCaps	Especifica si el texto de TextRange se establece para usar el atributo All Caps , que hace que las letras minúsculas aparezcan como letras mayúsculas. Los valores posibles son los siguientes: true : todo el texto tiene el atributo All Caps . false : ninguno de los textos tiene el atributo All Caps . null : se devuelve si algunos, pero no todos, del texto tienen el atributo All Caps .
bold	Especifica si el texto de TextRange está establecido en negrita. Los valores posibles son los siguientes: true : todo el texto está en negrita. false : ninguno de los textos está en negrita. null : se devuelve si algunos, pero no todos, del texto están en negrita.
color	Especifica la representación del código de color HTML del color de texto (por ejemplo, "#FF0000" representa el rojo). Devuelve null si TextRange contiene fragmentos de texto con colores diferentes.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
doubleStrikethrough	Especifica si el texto de TextRange está establecido para usar el atributo tachado Double . Los valores posibles son los siguientes: true : todo el texto tiene el atributo tachado Double . false : ninguno de los textos tiene el atributo tachado Double . null : se devuelve si algunos, pero no todos, del texto tienen el atributo tachado Double .
italic	Especifica si el texto de TextRange está establecido en cursiva. Los valores posibles son los siguientes: true : todo el texto está en cursiva. false : ninguno de los textos está en cursiva. null : se devuelve si algunos, pero no todos, del texto están en cursiva.
name	Especifica el nombre de fuente (por ejemplo, "Calibri"). Si el texto es un script complejo o un idioma asiático oriental, este es el nombre de fuente correspondiente; de lo contrario, es el nombre de la fuente latina. Devuelve null si TextRange contiene fragmentos de texto con nombres de fuente diferentes.
size	Especifica el tamaño de fuente en puntos (por ejemplo, 11). Devuelve null si TextRange contiene fragmentos de texto con tamaños de fuente diferentes.
smallCaps	Especifica si el texto de TextRange está establecido para usar el atributo Small Caps , que hace que las letras minúsculas aparezcan como letras minúsculas en mayúsculas pequeñas. Los valores posibles son los siguientes: true : todo el texto tiene el atributo Small Caps . false : ninguno de los textos tiene el atributo Small Caps . null : se devuelve si algunos, pero no todos, del texto tienen el atributo Small Caps .
strikethrough	Especifica si el texto de TextRange está establecido para usar el atributo Strikethrough . Los valores posibles son los siguientes: true : todo el texto tiene el atributo Strikethrough . false : ninguno de los textos tiene el atributo Strikethrough . null : se devuelve si algunos, pero no todos, del texto tienen el atributo Strikethrough .
subscript	Especifica si el texto de TextRange está establecido para usar el atributo Subscript . Los valores posibles son los siguientes: true : todo el texto tiene el atributo Subscript . false : ninguno de los textos tiene el atributo Subscript . null : se devuelve si algunos, pero no todos, del texto tienen el atributo Subscript .
superscript	Especifica si el texto de TextRange está establecido para usar el atributo Superscript . Los valores posibles son los siguientes: true : todo el texto tiene el atributo Superscript . false : ninguno de los textos tiene el atributo Superscript . null : se devuelve si algunos, pero no todos, del texto tienen el atributo Superscript .
underline	Especifica el tipo de subrayado aplicado a la fuente. Devuelve null si TextRange contiene fragmentos de texto con estilos de subrayado diferentes. Vea PowerPoint.ShapeFontUnderlineStyle para obtener más información.

Métodos

load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.ShapeFont es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeFontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

allCaps

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si el texto de TextRange se establece para usar el atributo All Caps , que hace que las letras minúsculas aparezcan como letras mayúsculas. Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo All Caps .

• false : ninguno de los textos tiene el atributo All Caps .

• null : se devuelve si algunos, pero no todos, del texto tienen el atributo All Caps .

allCaps: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

bold

Especifica si el texto de TextRange está establecido en negrita. Los valores posibles son los siguientes:

• true : todo el texto está en negrita.

• false : ninguno de los textos está en negrita.

• null : se devuelve si algunos, pero no todos, del texto están en negrita.

bold: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

color

Especifica la representación del código de color HTML del color de texto (por ejemplo, "#FF0000" representa el rojo). Devuelve null si TextRange contiene fragmentos de texto con colores diferentes.

color: string | null;

Valor de propiedad

string | null

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

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

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

doubleStrikethrough

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si el texto de TextRange está establecido para usar el atributo tachado Double . Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo tachado Double .

• false : ninguno de los textos tiene el atributo tachado Double .

• null : se devuelve si algunos, pero no todos, del texto tienen el atributo tachado Double .

doubleStrikethrough: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

italic

Especifica si el texto de TextRange está establecido en cursiva. Los valores posibles son los siguientes:

• true : todo el texto está en cursiva.

• false : ninguno de los textos está en cursiva.

• null : se devuelve si algunos, pero no todos, del texto están en cursiva.

italic: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

name

Especifica el nombre de fuente (por ejemplo, "Calibri"). Si el texto es un script complejo o un idioma asiático oriental, este es el nombre de fuente correspondiente; de lo contrario, es el nombre de la fuente latina. Devuelve null si TextRange contiene fragmentos de texto con nombres de fuente diferentes.

name: string | null;

Valor de propiedad

string | null

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

size

Especifica el tamaño de fuente en puntos (por ejemplo, 11). Devuelve null si TextRange contiene fragmentos de texto con tamaños de fuente diferentes.

size: number | null;

Valor de propiedad

number | null

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

smallCaps

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si el texto de TextRange está establecido para usar el atributo Small Caps , que hace que las letras minúsculas aparezcan como letras minúsculas en mayúsculas pequeñas. Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo Small Caps .

• false : ninguno de los textos tiene el atributo Small Caps .

• null : se devuelve si algunos, pero no todos, del texto tienen el atributo Small Caps .

smallCaps: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

strikethrough

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si el texto de TextRange está establecido para usar el atributo Strikethrough . Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo Strikethrough .

• false : ninguno de los textos tiene el atributo Strikethrough .

• null : se devuelve si algunos, pero no todos, del texto tienen el atributo Strikethrough .

strikethrough: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

subscript

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si el texto de TextRange está establecido para usar el atributo Subscript . Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo Subscript .

• false : ninguno de los textos tiene el atributo Subscript .

• null : se devuelve si algunos, pero no todos, del texto tienen el atributo Subscript .

subscript: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

superscript

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si el texto de TextRange está establecido para usar el atributo Superscript . Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo Superscript .

• false : ninguno de los textos tiene el atributo Superscript .

• null : se devuelve si algunos, pero no todos, del texto tienen el atributo Superscript .

superscript: boolean | null;

Valor de propiedad

boolean | null

Comentarios

[ Conjunto de API: PowerPointApi BETA (SOLO VERSIÓN PRELIMINAR) ]

underline

Especifica el tipo de subrayado aplicado a la fuente. Devuelve null si TextRange contiene fragmentos de texto con estilos de subrayado diferentes. Vea PowerPoint.ShapeFontUnderlineStyle para obtener más información.

underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;

Valor de propiedad

PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;

Parámetros

options

PowerPoint.Interfaces.ShapeFontLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

PowerPoint.ShapeFont

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

PowerPoint.ShapeFont

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

PowerPoint.ShapeFont

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.ShapeFont es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.ShapeFontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): PowerPoint.Interfaces.ShapeFontData;

Devoluciones

PowerPoint.Interfaces.ShapeFontData