Excel.PageBreak class

Paquete:

excel

Extends

OfficeExtension.ClientObject

Comentarios

Conjunto de API: ExcelApi 1.9

Usada por

• Excel.PageBreakCollection: add, getItem, items

Propiedades

columnIndex	Especifica el índice de columna para el salto de página.
context	El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
rowIndex	Especifica el índice de fila del salto de página.

Métodos

delete()	Elimina un objeto de salto de página.
getCellAfterBreak()	Obtiene la primera celda después del salto de página.
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()	Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PageBreak es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PageBreakData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

Detalles de las propiedades

columnIndex

Especifica el índice de columna para el salto de página.

readonly columnIndex: number;

Valor de propiedad

number

Comentarios

Conjunto de API: ExcelApi 1.9

context

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

rowIndex

Especifica el índice de fila del salto de página.

readonly rowIndex: number;

Valor de propiedad

number

Comentarios

Conjunto de API: ExcelApi 1.9

Detalles del método

delete()

Elimina un objeto de salto de página.

delete(): void;

Devoluciones

void

Comentarios

Conjunto de API: ExcelApi 1.9

getCellAfterBreak()

Obtiene la primera celda después del salto de página.

getCellAfterBreak(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

Conjunto de API: ExcelApi 1.9

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.PageBreakLoadOptions): Excel.PageBreak;

Parámetros

options

Excel.Interfaces.PageBreakLoadOptions

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

Devoluciones

Excel.PageBreak

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.PageBreak;

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.PageBreak

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.PageBreak;

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.PageBreak

toJSON()

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.PageBreak es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.PageBreakData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.PageBreakData;

Devoluciones

Excel.Interfaces.PageBreakData