Word.DocumentCreated class
El objeto DocumentCreated es el objeto de nivel superior creado por Application.CreateDocument. Un objeto DocumentCreated es un objeto Document especial.
- Extends
Comentarios
[ Conjunto de API: WordApi 1.3 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml
// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
// Use the Base64-encoded string representation of the selected .docx file.
const externalDoc: Word.DocumentCreated = context.application.createDocument(externalDocument);
await context.sync();
const externalDocBody: Word.Body = externalDoc.body;
externalDocBody.load("text");
await context.sync();
// Insert the external document's text at the beginning of the current document's body.
const externalDocBodyText = externalDocBody.text;
const currentDocBody: Word.Body = context.document.body;
currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
await context.sync();
});
Propiedades
| body | Obtiene el objeto body del documento. El cuerpo es el texto que excluye encabezados, pies de página, notas al pie, cuadros de texto, etc. |
| content |
Obtiene la colección de objetos de control de contenido del documento. Esto incluye controles de contenido en el cuerpo del documento, encabezados, pies de página, cuadros de texto, etc. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| custom |
Obtiene los elementos XML personalizados del documento. |
| properties | Obtiene las propiedades del documento. |
| saved | Indica si se guardaron los cambios en el documento. Un valor de true indica que el documento no cambió desde que se guardó. |
| sections | Obtiene la colección de objetos de sección del documento. |
| settings | Obtiene la configuración del complemento en el documento. |
Métodos
| add |
Agrega un estilo al documento por nombre y tipo. |
| add |
Agrega un estilo al documento por nombre y tipo. |
| delete |
Elimina un marcador, si existe, del documento. |
| get |
Obtiene el intervalo de un marcador. Produce un |
| get |
Obtiene el intervalo de un marcador. Si el marcador no existe, este método devolverá un objeto con su |
| get |
Obtiene los controles de contenido admitidos actualmente en el documento. |
| get |
Obtiene un objeto StyleCollection que representa todo el conjunto de estilos del documento. |
| insert |
Inserta un documento en el documento de destino en una ubicación específica con propiedades adicionales. Los encabezados, pies de página, marcas de agua y otras propiedades de sección se copian de forma predeterminada. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| open() | Abre el documento. |
| save(save |
Guarda el documento. |
| save(save |
Guarda el documento. |
| 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. |
| toJSON() | Invalida el método JavaScript |
| track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre |
| untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar |
Detalles de las propiedades
body
Obtiene el objeto body del documento. El cuerpo es el texto que excluye encabezados, pies de página, notas al pie, cuadros de texto, etc.
readonly body: Word.Body;Valor de propiedad
Comentarios
contentControls
Obtiene la colección de objetos de control de contenido del documento. Esto incluye controles de contenido en el cuerpo del documento, encabezados, pies de página, cuadros de texto, etc.
readonly contentControls: Word.ContentControlCollection;Valor de propiedad
Comentarios
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
customXmlParts
Obtiene los elementos XML personalizados del documento.
readonly customXmlParts: Word.CustomXmlPartCollection;Valor de propiedad
Comentarios
properties
Obtiene las propiedades del documento.
readonly properties: Word.DocumentProperties;Valor de propiedad
Comentarios
saved
Indica si se guardaron los cambios en el documento. Un valor de true indica que el documento no cambió desde que se guardó.
readonly saved: boolean;Valor de propiedad
boolean
Comentarios
sections
Obtiene la colección de objetos de sección del documento.
readonly sections: Word.SectionCollection;Valor de propiedad
Comentarios
settings
Obtiene la configuración del complemento en el documento.
readonly settings: Word.SettingCollection;Valor de propiedad
Comentarios
Detalles del método
addStyle(name, type)
Agrega un estilo al documento por nombre y tipo.
addStyle(name: string, type: Word.StyleType): Word.Style;Parámetros
- name
-
string
Obligatorio. Cadena que representa el nombre del estilo.
- type
- Word.StyleType
Obligatorio. Tipo de estilo, incluido el carácter, la lista, el párrafo o la tabla.
Devoluciones
Comentarios
addStyle(name, typeString)
Agrega un estilo al documento por nombre y tipo.
addStyle(name: string, typeString: "Character" | "List" | "Paragraph" | "Table"): Word.Style;Parámetros
- name
-
string
Obligatorio. Cadena que representa el nombre del estilo.
- typeString
-
"Character" | "List" | "Paragraph" | "Table"
Obligatorio. Tipo de estilo, incluido el carácter, la lista, el párrafo o la tabla.
Devoluciones
Comentarios
deleteBookmark(name)
Elimina un marcador, si existe, del documento.
deleteBookmark(name: string): void;Parámetros
- name
-
string
Obligatorio. Nombre del marcador que no distingue mayúsculas de minúsculas.
Devoluciones
void
Comentarios
getBookmarkRange(name)
Obtiene el intervalo de un marcador. Produce un ItemNotFound error si el marcador no existe.
getBookmarkRange(name: string): Word.Range;Parámetros
- name
-
string
Obligatorio. Nombre del marcador que no distingue mayúsculas de minúsculas.
Devoluciones
Comentarios
getBookmarkRangeOrNullObject(name)
Obtiene el intervalo de un marcador. Si el marcador no existe, 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).
getBookmarkRangeOrNullObject(name: string): Word.Range;Parámetros
- name
-
string
Obligatorio. Nombre del marcador que no distingue mayúsculas de minúsculas. Solo se admiten caracteres alfanuméricos y de subrayado. Debe comenzar con una letra, pero si desea etiquetar el marcador como oculto, inicie el nombre con un carácter de subrayado. Los nombres no pueden tener más de 40 caracteres.
Devoluciones
Comentarios
getContentControls(options)
Obtiene los controles de contenido admitidos actualmente en el documento.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;Parámetros
- options
- Word.ContentControlOptions
Opcional. Opciones que definen qué controles de contenido se devuelven.
Devoluciones
Comentarios
[ Conjunto de API: WordApiHiddenDocument 1.5 ]
Importante: Si se proporcionan tipos específicos en el parámetro options, solo se devuelven los controles de contenido de los tipos admitidos. Tenga en cuenta que se iniciará una excepción en el uso de métodos de un Word genérico. ContentControl que no son relevantes para el tipo específico. Con el tiempo, se pueden admitir tipos adicionales de controles de contenido. Por lo tanto, el complemento debe solicitar y controlar tipos específicos de controles de contenido.
getStyles()
Obtiene un objeto StyleCollection que representa todo el conjunto de estilos del documento.
getStyles(): Word.StyleCollection;Devoluciones
Comentarios
insertFileFromBase64(base64File, insertLocation, insertFileOptions)
Inserta un documento en el documento de destino en una ubicación específica con propiedades adicionales. Los encabezados, pies de página, marcas de agua y otras propiedades de sección se copian de forma predeterminada.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;Parámetros
- base64File
-
string
Obligatorio. Contenido codificado en Base64 de un archivo .docx.
Obligatorio. El valor debe ser "Replace", "Start" o "End".
- insertFileOptions
- Word.InsertFileOptions
Opcional. Propiedades adicionales que se deben importar al documento de destino.
Devoluciones
Comentarios
[ Conjunto de API: WordApiHiddenDocument 1.5 ]
Nota: La inserción no se admite si el documento que se está insertando contiene un control ActiveX (probablemente en un campo de formulario). Considere la posibilidad de reemplazar este tipo de campo de formulario por un control de contenido u otra opción adecuada para su escenario.
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?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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[]): Word.DocumentCreated;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
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;
}): Word.DocumentCreated;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
open()
Abre el documento.
open(): void;Devoluciones
void
Comentarios
[ Conjunto de API: WordApi 1.3 ]
Ejemplos
// Create and open a new document in a new tab or window.
await Word.run(async (context) => {
const externalDoc = context.application.createDocument();
await context.sync();
externalDoc.open();
await context.sync();
});
save(saveBehavior, fileName)
Guarda el documento.
save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;Parámetros
- saveBehavior
- Word.SaveBehavior
Opcional. DocumentCreated solo admite "Guardar".
- fileName
-
string
Opcional. Nombre de archivo (extensión de archivo de exclusión). Solo surte efecto para un documento nuevo.
Devoluciones
void
Comentarios
[ Conjunto de API: WordApiHiddenDocument 1.3 ]
Nota: Los saveBehavior parámetros y fileName se introdujeron en WordApiHiddenDocument 1.5.
save(saveBehaviorString, fileName)
Guarda el documento.
save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;Parámetros
- saveBehaviorString
-
"Save" | "Prompt"
Opcional. DocumentCreated solo admite "Guardar".
- fileName
-
string
Opcional. Nombre de archivo (extensión de archivo de exclusión). Solo surte efecto para un documento nuevo.
Devoluciones
void
Comentarios
[ Conjunto de API: WordApiHiddenDocument 1.3 ]
Nota: Los saveBehavior parámetros y fileName se introdujeron en WordApiHiddenDocument 1.5.
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.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Word.Interfaces.DocumentCreatedUpdateData
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: Word.DocumentCreated): void;Parámetros
- properties
- Word.DocumentCreated
Devoluciones
void
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 Word.DocumentCreated es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.DocumentCreatedData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Word.Interfaces.DocumentCreatedData;Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
track(): Word.DocumentCreated;Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.
untrack(): Word.DocumentCreated;