Word.Interfaces.FieldLoadOptions interface

Paquete:

word

Representa un campo.

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Propiedades

$all	Si se $all especifica para LoadOptions, se cargan todas las propiedades escalares (por ejemplo, Range.address) pero no las propiedades de navegación (por ejemplo, Range.format.fill.color).
code	Especifica la instrucción de código del campo.
data	Especifica los datos de un campo "Addin". Si el campo no es un campo "Addin", es null y producirá una excepción general cuando el código intente establecerlo.
kind	Obtiene el tipo de campo.
locked	Especifica si el campo está bloqueado. true si el campo está bloqueado, false de lo contrario.
parentBody	Obtiene el cuerpo primario del campo.
parentContentControl	Obtiene el control de contenido que contiene el campo. Produce un ItemNotFound error si no hay un control de contenido primario.
parentContentControlOrNullObject	Obtiene el control de contenido que contiene el campo. Si no hay un control de contenido primario, este método devolverá 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).
parentTable	Obtiene la tabla que contiene el campo . Produce un ItemNotFound error si no está incluido en una tabla.
parentTableCell	Obtiene la celda de tabla que contiene el campo . Produce un ItemNotFound error si no está contenido en una celda de tabla.
parentTableCellOrNullObject	Obtiene la celda de tabla que contiene el campo . Si no está contenido en una celda de tabla, este método devolverá 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).
parentTableOrNullObject	Obtiene la tabla que contiene el campo . Si no está contenido en una tabla, este método devolverá 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).
result	Obtiene los datos de resultados del campo.
showCodes	Especifica si se muestran los códigos de campo para el campo especificado. true si se muestran los códigos de campo, false de lo contrario.
type	Obtiene el tipo del campo.

Detalles de las propiedades

$all

Si se $all especifica para LoadOptions, se cargan todas las propiedades escalares (por ejemplo, Range.address) pero no las propiedades de navegación (por ejemplo, Range.format.fill.color).

$all?: boolean;

Valor de propiedad

boolean

code

Especifica la instrucción de código del campo.

code?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Nota: La capacidad de establecer el código se introdujo en WordApi 1.5.

data

Especifica los datos de un campo "Addin". Si el campo no es un campo "Addin", es null y producirá una excepción general cuando el código intente establecerlo.

data?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

kind

Obtiene el tipo de campo.

kind?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

locked

Especifica si el campo está bloqueado. true si el campo está bloqueado, false de lo contrario.

locked?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

parentBody

Obtiene el cuerpo primario del campo.

parentBody?: Word.Interfaces.BodyLoadOptions;

Valor de propiedad

Word.Interfaces.BodyLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

parentContentControl

Obtiene el control de contenido que contiene el campo. Produce un ItemNotFound error si no hay un control de contenido primario.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Valor de propiedad

Word.Interfaces.ContentControlLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

parentContentControlOrNullObject

Obtiene el control de contenido que contiene el campo. Si no hay un control de contenido primario, este método devolverá 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).

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Valor de propiedad

Word.Interfaces.ContentControlLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

parentTable

Obtiene la tabla que contiene el campo . Produce un ItemNotFound error si no está incluido en una tabla.

parentTable?: Word.Interfaces.TableLoadOptions;

Valor de propiedad

Word.Interfaces.TableLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

parentTableCell

Obtiene la celda de tabla que contiene el campo . Produce un ItemNotFound error si no está contenido en una celda de tabla.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Valor de propiedad

Word.Interfaces.TableCellLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

parentTableCellOrNullObject

Obtiene la celda de tabla que contiene el campo . Si no está contenido en una celda de tabla, este método devolverá 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).

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Valor de propiedad

Word.Interfaces.TableCellLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

parentTableOrNullObject

Obtiene la tabla que contiene el campo . Si no está contenido en una tabla, este método devolverá 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).

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Valor de propiedad

Word.Interfaces.TableLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

result

Obtiene los datos de resultados del campo.

result?: Word.Interfaces.RangeLoadOptions;

Valor de propiedad

Word.Interfaces.RangeLoadOptions

Comentarios

[ Conjunto de API: WordApi 1.4 ]

showCodes

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica si se muestran los códigos de campo para el campo especificado. true si se muestran los códigos de campo, false de lo contrario.

showCodes?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

type

Obtiene el tipo del campo.

type?: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]