Excel.AllowEditRange class

Paquete:

excel

Representa un AllowEditRange objeto encontrado en una hoja de cálculo. Este objeto funciona 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

address	Especifica el intervalo asociado al objeto . 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 AccessDenied error y no puede establecer el intervalo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
isPasswordProtected	Especifica si el objeto está protegido con contraseña.
title	Especifica el título del objeto. 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 AccessDenied error y no puede establecer el título. Si ya hay un existente AllowEditRange con la misma cadena o si la cadena está o está null vacía (""), este método produce un InvalidArgument error y no puede establecer el título.

Métodos

delete()	Elimina el objeto de .AllowEditRangeCollection 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 produce un AccessDenied error en la operación de eliminación.
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 el objeto 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 ya 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 del objeto. Si la contraseña es incorrecta, este método produce un BadPassword error y no puede pausar la protección del objeto. Si se proporciona una contraseña pero el objeto no requiere una contraseña, la contraseña especificada se omitirá y la operación se realizará correctamente.
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.
setPassword(password)	Cambia la contraseña asociada al objeto . Establecer la cadena de contraseña como vacía ("") o null quitará la protección con contraseña del objeto. 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 set.
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.AllowEditRange original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.AllowEditRangeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

address

Especifica el intervalo asociado al objeto . 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 AccessDenied error y no puede establecer el intervalo.

address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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

isPasswordProtected

Especifica si el objeto está protegido con contraseña.

readonly isPasswordProtected: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

title

Especifica el título del objeto. 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 AccessDenied error y no puede establecer el título. Si ya hay un existente AllowEditRange con la misma cadena o si la cadena está o está null vacía (""), este método produce un InvalidArgument error y no puede establecer el título.

title: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalles del método

delete()

Elimina el objeto de .AllowEditRangeCollection 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 produce un AccessDenied error en la operación de eliminación.

delete(): void;

Devoluciones

void

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.AllowEditRangeLoadOptions): Excel.AllowEditRange;

Parámetros

options

Excel.Interfaces.AllowEditRangeLoadOptions

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

Devoluciones

Excel.AllowEditRange

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

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

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

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

pauseProtection(password)

Pausa la protección de la hoja de cálculo para el objeto 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 ya 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 del objeto. Si la contraseña es incorrecta, este método produce un BadPassword error y no puede pausar la protección del objeto. Si se proporciona una contraseña pero el objeto no requiere una contraseña, la contraseña especificada se omitirá y la operación se realizará correctamente.

pauseProtection(password?: string): void;

Parámetros

password

string

Contraseña asociada al AllowEditRange objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiOnline 1.1 ]

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.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Excel.Interfaces.AllowEditRangeUpdateData

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.AllowEditRange): void;

Parámetros

properties

Excel.AllowEditRange

Devoluciones

void

setPassword(password)

Cambia la contraseña asociada al objeto . Establecer la cadena de contraseña como vacía ("") o null quitará la protección con contraseña del objeto. 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 set.

setPassword(password?: string): void;

Parámetros

password

string

Contraseña asociada al AllowEditRange objeto .

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

toJSON(): Excel.Interfaces.AllowEditRangeData;

Devoluciones

Excel.Interfaces.AllowEditRangeData