Excel.AllowEditRangeCollection class

Paquete:

excel

Representa el conjunto de AllowEditRange objetos que se encuentran en una hoja de cálculo. AllowEditRange los objetos funcionan con propiedades de protección de hoja de cálculo. Cuando se habilita la protección de la hoja de cálculo, se puede usar un AllowEditRange objeto para permitir la edición de un rango específico, a la vez que se mantiene la protección en el resto de la hoja de cálculo.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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(title, rangeAddress, options)	Agrega un AllowEditRange objeto a la hoja de cálculo. La protección de la hoja de cálculo debe deshabilitarse o pausarse para que este método funcione correctamente. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un error y se produce un AccessDenied error en la operación de adición.
getCount()	Devuelve el número de objetos de AllowEditRange la colección.
getItem(key)	Obtiene el AllowEditRange objeto por su título.
getItemAt(index)	Devuelve un AllowEditRange objeto por su índice en la colección.
getItemOrNullObject(key)	Obtiene el AllowEditRange objeto por su título.
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.
pauseProtection(password)	Pausa la protección de la hoja de cálculo para todos los AllowEditRange objetos que se encuentran en esta hoja de cálculo que tienen la contraseña especificada para el usuario en la sesión actual. Este método no hace nada si la protección de la hoja de cálculo no está habilitada o está en pausa. Si no se puede pausar la protección de la hoja de cálculo, este método produce un UnsupportedOperation error y no puede pausar la protección para el intervalo. Si la contraseña no coincide con ningún AllowEditRange objeto de la colección, este método produce un BadPassword error y no puede pausar la protección para cualquier intervalo de la colección.
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.AllowEditRangeCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.AllowEditRangeCollectionData) 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.AllowEditRange[];

Valor de propiedad

Excel.AllowEditRange[]

Detalles del método

add(title, rangeAddress, options)

Agrega un AllowEditRange objeto a la hoja de cálculo. La protección de la hoja de cálculo debe deshabilitarse o pausarse para que este método funcione correctamente. Si la protección de la hoja de cálculo está habilitada y no está en pausa, este método produce un error y se produce un AccessDenied error en la operación de adición.

add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;

Parámetros

title

string

Cadena de título del AllowEditRange objeto que se va a agregar.

rangeAddress

string

Dirección del intervalo del AllowEditRange objeto que se va a agregar.

options

Excel.AllowEditRangeOptions

Opciones adicionales que se van a agregar al AllowEditRange objeto, como la contraseña.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getCount()

Devuelve el número de objetos de AllowEditRange la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItem(key)

Obtiene el AllowEditRange objeto por su título.

getItem(key: string): Excel.AllowEditRange;

Parámetros

key

string

Título de .AllowEditRange

Devoluciones

Excel.AllowEditRange

con AllowEditRange el título. Si no hay ninguna AllowEditRange con el título especificado, se produce un ItemNotFound error.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemAt(index)

Devuelve un AllowEditRange objeto por su índice en la colección.

getItemAt(index: number): Excel.AllowEditRange;

Parámetros

index

number

Índice del AllowEditRange objeto de la colección.

Devoluciones

Excel.AllowEditRange

en AllowEditRange el índice especificado.

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Obtiene el AllowEditRange objeto por su título.

getItemOrNullObject(key: string): Excel.AllowEditRange;

Parámetros

key

string

Título de .AllowEditRange

Devoluciones

Excel.AllowEditRange

con AllowEditRange el título. Si no hay ninguna AllowEditRange con el título especificado, 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).

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

Parámetros

options

Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.AllowEditRangeCollection

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

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

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

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

pauseProtection(password)

Pausa la protección de la hoja de cálculo para todos los AllowEditRange objetos que se encuentran en esta hoja de cálculo que tienen la contraseña especificada para el usuario en la sesión actual. Este método no hace nada si la protección de la hoja de cálculo no está habilitada o está en pausa. Si no se puede pausar la protección de la hoja de cálculo, este método produce un UnsupportedOperation error y no puede pausar la protección para el intervalo. Si la contraseña no coincide con ningún AllowEditRange objeto de la colección, este método produce un BadPassword error y no puede pausar la protección para cualquier intervalo de la colección.

pauseProtection(password: string): void;

Parámetros

password

string

Contraseña para pausar la protección en los AllowEditRange objetos.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;

Devoluciones

Excel.Interfaces.AllowEditRangeCollectionData