Excel.HeaderFooterGroup class

Paquete:

excel

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
defaultForAllPages	El encabezado o pie general, utilizado para todas las páginas, salvo que se indique par, impar o primera página.
evenPages	El encabezado o pie de página para páginas pares, debe especificarse el encabezado o pie de página para páginas impares.
firstPage	El encabezado o pie de página de la primera página, para las demás páginas se usa el encabezado o pie de página general, par o impar.
oddPages	El encabezado o pie de página para páginas impares, debe especificarse el encabezado o pie de página para páginas pares.
state	Estado por el que se establecen los encabezados o pies de página. Vea Excel.HeaderFooterState para más información.
useSheetMargins	Obtiene o establece una marca que indica si los encabezados o pies de página están alineados con los márgenes de página establecidos en las opciones de diseño de página de la hoja de cálculo.
useSheetScale	Obtiene o establece una marca que indica si los encabezados o pies de página deben escalarse según la escala de porcentaje de página establecida en las opciones de diseño de página de la hoja de cálculo.

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.
set(properties, options)	Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
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 Excel.HeaderFooterGroup original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.HeaderFooterGroupData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

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

Excel.RequestContext

defaultForAllPages

El encabezado o pie general, utilizado para todas las páginas, salvo que se indique par, impar o primera página.

readonly defaultForAllPages: Excel.HeaderFooter;

Valor de propiedad

Excel.HeaderFooter

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

evenPages

El encabezado o pie de página para páginas pares, debe especificarse el encabezado o pie de página para páginas impares.

readonly evenPages: Excel.HeaderFooter;

Valor de propiedad

Excel.HeaderFooter

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

firstPage

El encabezado o pie de página de la primera página, para las demás páginas se usa el encabezado o pie de página general, par o impar.

readonly firstPage: Excel.HeaderFooter;

Valor de propiedad

Excel.HeaderFooter

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

oddPages

El encabezado o pie de página para páginas impares, debe especificarse el encabezado o pie de página para páginas pares.

readonly oddPages: Excel.HeaderFooter;

Valor de propiedad

Excel.HeaderFooter

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

state

Estado por el que se establecen los encabezados o pies de página. Vea Excel.HeaderFooterState para más información.

state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";

Valor de propiedad

Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

useSheetMargins

Obtiene o establece una marca que indica si los encabezados o pies de página están alineados con los márgenes de página establecidos en las opciones de diseño de página de la hoja de cálculo.

useSheetMargins: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

useSheetScale

Obtiene o establece una marca que indica si los encabezados o pies de página deben escalarse según la escala de porcentaje de página establecida en las opciones de diseño de página de la hoja de cálculo.

useSheetScale: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;

Parámetros

options

Excel.Interfaces.HeaderFooterGroupLoadOptions

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

Devoluciones

Excel.HeaderFooterGroup

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[]): Excel.HeaderFooterGroup;

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

Excel.HeaderFooterGroup

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;
        }): Excel.HeaderFooterGroup;

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

Excel.HeaderFooterGroup

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties

Excel.Interfaces.HeaderFooterGroupUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.HeaderFooterGroup): void;

Parámetros

properties

Excel.HeaderFooterGroup

Devoluciones

void

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 Excel.HeaderFooterGroup original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.HeaderFooterGroupData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.HeaderFooterGroupData;

Devoluciones

Excel.Interfaces.HeaderFooterGroupData