Excel.TimelineStyleCollection class

Paquete:

excel

Representa una colección de estilos de escala de tiempo.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(name, makeUniqueName)	Crea un espacio en blanco TimelineStyle con el nombre especificado.
getCount()	Obtiene el número de estilos de escala de tiempo de la colección.
getDefault()	Obtiene el estilo de escala de tiempo predeterminado para el ámbito del objeto primario.
getItem(name)	Obtiene un valor TimelineStyle por nombre.
getItemOrNullObject(name)	Obtiene un valor TimelineStyle por nombre. Si el estilo de escala de tiempo no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
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.
setDefault(newDefaultStyle)	Establece el estilo de escala de tiempo predeterminado para su uso en el ámbito del objeto primario.
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 Excel.TimelineStyleCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TimelineStyleCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

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

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.TimelineStyle[];

Valor de propiedad

Excel.TimelineStyle[]

Detalles del método

add(name, makeUniqueName)

Crea un espacio en blanco TimelineStyle con el nombre especificado.

add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;

Parámetros

name

string

Nombre único del nuevo estilo de escala de tiempo. Producirá un InvalidArgument error si el nombre ya está en uso.

makeUniqueName

boolean

Opcional. El valor predeterminado es false. Si truees , anexará números al nombre para que sea único, si es necesario.

Devoluciones

Excel.TimelineStyle

Recién creado TimelineStyle.

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

getCount()

Obtiene el número de estilos de escala de tiempo de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

getDefault()

Obtiene el estilo de escala de tiempo predeterminado para el ámbito del objeto primario.

getDefault(): Excel.TimelineStyle;

Devoluciones

Excel.TimelineStyle

Objeto TimelineStyle que es el estilo de escala de tiempo predeterminado actual.

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

getItem(name)

Obtiene un valor TimelineStyle por nombre.

getItem(name: string): Excel.TimelineStyle;

Parámetros

name

string

Nombre del estilo de escala de tiempo que se va a recuperar.

Devoluciones

Excel.TimelineStyle

Objeto TimelineStyle cuyo nombre coincide con la entrada.

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

getItemOrNullObject(name)

Obtiene un valor TimelineStyle por nombre. Si el estilo de escala de tiempo no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(name: string): Excel.TimelineStyle;

Parámetros

name

string

Nombre del estilo de escala de tiempo que se va a recuperar.

Devoluciones

Excel.TimelineStyle

Objeto TimelineStyle cuyo nombre coincide con la entrada.

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;

Parámetros

options

Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.TimelineStyleCollection

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

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

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?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;

Parámetros

propertyNamesAndPaths

OfficeExtension.LoadOption

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

setDefault(newDefaultStyle)

Establece el estilo de escala de tiempo predeterminado para su uso en el ámbito del objeto primario.

setDefault(newDefaultStyle: TimelineStyle | string): void;

Parámetros

newDefaultStyle

Excel.TimelineStyle | string

Objeto TimelineStyle , o nombre del TimelineStyle objeto, que debe ser el nuevo valor predeterminado.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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 Excel.TimelineStyleCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.TimelineStyleCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.TimelineStyleCollectionData;

Devoluciones

Excel.Interfaces.TimelineStyleCollectionData