Document

Visão geral

Document é uma classe em Aspose.Words FOSS para .NET. Herda de: DocumentBase, ISectionAttrSource, IWatermarkProvider.

Os construtores da classe Document permitem que os desenvolvedores criem um novo documento vazio ou carreguem um existente a partir de um caminho de arquivo, fluxo ou com opções de carregamento personalizadas.

Esta classe fornece 63 métodos para trabalhar com objetos Document em programas .NET. Os métodos disponíveis incluem: Accept, AcceptAllRevisions, AcceptEnd, AcceptStart, AppendChild, AppendDocument, Cleanup, Clone, CopyStylesFromTemplate, CreateNavigator, Document, EnsureMinimum e 36 métodos adicionais. Todos os membros públicos estão acessíveis a qualquer aplicação .NET após a instalação do pacote Aspose.Words FOSS para .NET. Propriedades: AttachedTemplate, AutomaticallyUpdateStyles, BackgroundShape, Bibliography, BuiltInDocumentProperties, CompatibilityOptions e mais 62.

Propriedades

Nome	Tipo	Acesso	Descrição
`AttachedTemplate`	`string`	Leitura/Escrita	Obtém ou define o caminho completo do modelo anexado ao documento.
`AutomaticallyUpdateStyles`	`bool`	Leitura/Escrita	Obtém ou define um sinalizador que indica se os estilos no documento são atualizados para corresponder aos estilos no modelo anexado toda vez que o documento é aberto no MS Word.
`ShadeFormData`	`bool`	Leitura/Escrita	Especifica se deve ativar o sombreamento cinza nos campos de formulário.
`TrackRevisions`	`bool`	Leitura/Escrita	Verdadeiro se as alterações forem rastreadas quando este documento for editado no Microsoft Word.
`ShowGrammaticalErrors`	`bool`	Leitura/Escrita	Especifica se deve exibir erros gramaticais neste documento.
`ShowSpellingErrors`	`bool`	Leitura/Escrita	Especifica se deve exibir erros ortográficos neste documento.
`SpellingChecked`	`bool`	Leitura/Escrita	Retorna true se o documento foi verificado quanto à ortografia.
`GrammarChecked`	`bool`	Leitura/Escrita	Retorna true se o documento foi verificado quanto à gramática.
`PunctuationKerning`	`bool`	Leitura/Escrita	Especifica se o kerning se aplica tanto ao texto latino quanto à pontuação.
`NodeType`	`NodeType`	Leitura	Retorna Document.
`BuiltInDocumentProperties`	`BuiltInDocumentProperties`	Leitura	Retorna uma coleção que representa todas as propriedades de documento incorporadas do documento.
`WebExtensionTaskPanes`	`TaskPaneCollection`	Leitura	Retorna uma coleção que representa uma lista de suplementos de painel de tarefas.
`CustomDocumentProperties`	`CustomDocumentProperties`	Leitura	Retorna uma coleção que representa todas as propriedades de documento personalizadas do documento.
`ProtectionType`	`ProtectionType`	Leitura	Obtém o tipo de proteção de documento atualmente ativo.
`Sections`	`SectionCollection`	Leitura	Retorna uma coleção que representa todas as seções do documento.
`FirstSection`	`Section`	Leitura	Obtém a primeira seção do documento.
`LastSection`	`Section`	Leitura	Obtém a última seção no documento.
`ViewOptions`	`ViewOptions`	Leitura	Fornece opções para controlar como o documento é exibido no Microsoft Word.
`WriteProtection`	`WriteProtection`	Leitura	Fornece acesso às opções de proteção contra gravação do documento.
`CompatibilityOptions`	`CompatibilityOptions`	Leitura	Fornece acesso às opções de compatibilidade de documento (ou seja, as preferências do usuário inseridas na guia Compatibilidade da caixa de diálogo Opções no Word).
`MailMergeSettings`	`MailMergeSettings`	Leitura/Escrita	Obtém ou define o objeto que contém todas as informações de mala direta de um documento.
`HyphenationOptions`	`HyphenationOptions`	Leitura	Fornece acesso às opções de hifenização de documento.
`HasRevisions`	`bool`	Leitura	Retorna true se o documento contém alterações rastreadas.
`HasMacros`	`bool`	Leitura	Retorna true se o documento possui um projeto VBA (macros).
`Watermark`	`Watermark`	Leitura	Fornece acesso à marca d’água do documento.
`VersionsCount`	`int`	Leitura	Obtém o número de versões do documento que foi armazenado no documento DOC.
`DefaultTabStop`	`double`	Leitura/Escrita	Obtém ou define o intervalo (em pontos) entre as paradas de tabulação padrão.
`Theme`	`Theme`	Leitura	Obtém o objeto `Theme` para este documento.
`CustomXmlParts`	`CustomXmlPartCollection`	Leitura/Escrita	Obtém ou define a coleção de Partes de Armazenamento de Dados Personalizadas XML.
`PackageCustomParts`	`CustomPartCollection`	Leitura/Escrita	Obtém ou define a coleção de partes personalizadas (conteúdo arbitrário) que são vinculadas ao pacote OOXML usando “relacionamentos desconhecidos”.
`Variables`	`VariableCollection`	Leitura	Retorna a coleção de variáveis adicionadas a um documento ou modelo.
`GlossaryDocument`	`GlossaryDocument`	Leitura/Escrita	Obtém ou define o documento de glossário dentro deste documento ou modelo.
`OriginalFileName`	`string`	Leitura	Obtém o nome original do arquivo do documento.
`OriginalLoadFormat`	`LoadFormat`	Leitura	Obtém o formato do documento original que foi carregado neste objeto.
`Compliance`	`OoxmlCompliance`	Leitura	Obtém a versão de conformidade OOXML determinada a partir do conteúdo do documento carregado.
`DigitalSignatures`	`DigitalSignatureCollection`	Leitura	Obtém a coleção de assinaturas digitais deste documento e seus resultados de validação.
`FontSettings`	`FontSettings`	Leitura/Escrita	Obtém ou define as configurações de fonte do documento.
`Bibliography`	`Bibliography.Bibliography`	Leitura	Obtém o objeto Bibliography que representa a lista de fontes disponíveis no documento.
`Frameset`	`Frameset`	Leitura	Retorna uma instância de Frameset se este documento representar uma página de frames.
`IncludeTextboxesFootnotesEndnotesInStat`	`bool`	Leitura/Escrita	Especifica se deve incluir caixas de texto, notas de rodapé e notas finais nas estatísticas de contagem de palavras.
`Revisions`	`RevisionCollection`	Leitura	Obtém uma coleção de revisões (alterações rastreadas) que existem neste documento.
`RevisionsView`	`RevisionsView`	Leitura/Escrita	Obtém ou define um valor que indica se deve trabalhar com a versão original ou revisada de um documento.
`JustificationMode`	`JustificationMode`	Leitura/Escrita	Obtém ou define o ajuste de espaçamento de caracteres de um documento.
`FootnoteOptions`	`FootnoteOptions`	Leitura	Fornece opções que controlam a numeração e o posicionamento de notas de rodapé neste documento.
`EndnoteOptions`	`EndnoteOptions`	Leitura	Fornece opções que controlam a numeração e o posicionamento de notas finais neste documento.
`FieldOptions`	`FieldOptions`	Leitura	Obtém um objeto FieldOptions que representa opções para controlar o manuseio de campos no documento.
`RemovePersonalInformation`	`bool`	Leitura/Escrita	Obtém ou define um sinalizador que indica que o Microsoft Word removerá todas as informações do usuário de comentários, revisões e propriedades do documento ao salvar o documento.
`VbaProject`	`VbaProject`	Leitura/Escrita	Obtém ou define um VbaProject.
`Document`	`DocumentBase`	Leitura	Obtém esta instância.
`NodeChangingCallback`	`INodeChangingCallback`	Leitura/Escrita	Chamado quando um nó é inserido ou removido no documento.
`ResourceLoadingCallback`	`IResourceLoadingCallback`	Leitura/Escrita	Permite controlar como recursos externos são carregados.
`FontInfos`	`FontInfoCollection`	Leitura	Fornece acesso às propriedades das fontes usadas neste documento.
`Styles`	`StyleCollection`	Leitura	Retorna uma coleção de estilos definidos no documento.
`Lists`	`ListCollection`	Leitura	Fornece acesso à formatação de listas usada no documento.
`WarningCallback`	`IWarningCallback`	Leitura/Escrita	Chamado durante vários procedimentos de processamento de documentos quando é detectado um problema que pode resultar em perda de fidelidade dos dados ou da formatação.
`FootnoteSeparators`	`FootnoteSeparatorCollection`	Leitura	Fornece acesso aos separadores de notas de rodapé/fim de nota definidos no documento.
`BackgroundShape`	`Shape`	Leitura/Escrita	Obtém ou define a forma de fundo do documento.
`PageColor`	`Color`	Leitura/Escrita	Obtém ou define a cor da página do documento.
`IsComposite`	`bool`	Leitura	Retorna true, pois este nó pode ter nós filhos.
`HasChildNodes`	`bool`	Leitura	Retorna true se este nó tem nós filhos.
`FirstChild`	`Node`	Leitura	Obtém o primeiro filho do nó.
`LastChild`	`Node`	Leitura	Obtém o último filho do nó.
`Count`	`int`	Leitura	Obtém o número de filhos imediatos deste nó.
`ParentNode`	`CompositeNode`	Leitura	Obtém o pai imediato deste nó.
`PreviousSibling`	`Node`	Leitura	Obtém o nó imediatamente anterior a este nó.
`NextSibling`	`Node`	Leitura	Obtém o nó imediatamente seguinte a este nó.
`Range`	`Range`	Leitura	Retorna um objeto Range que representa a parte de um documento que está contida neste nó.
`CustomNodeId`	`int`	Leitura/Escrita	Especifica um identificador de nó personalizado.

Métodos

Assinatura	Descrição
`Document()`	Cria ou carrega um documento.
`Document(fileName: string)`	Abre um documento existente a partir de um arquivo.
`Document(fileName: string, loadOptions: LoadOptions)`	Abre um documento existente a partir de um arquivo.
`Document(stream: Stream)`	Chama Document(stream) nesta instância de Document.
`Document(stream: Stream, loadOptions: LoadOptions)`	Chama Document(stream, loadOptions) nesta instância de Document.
`Clone()`	Executa uma cópia profunda do Document.
`Accept(visitor: DocumentVisitor)`	Chama VisitDocumentStart, então chama Accept para todos os nós filhos do documento e chama VisitDocumentEnd no final.
`AcceptStart(visitor: DocumentVisitor)`	Aceita um visitante para visitar o início do documento.
`AcceptEnd(visitor: DocumentVisitor)`	Aceita um visitante para visitar o final do documento.
`AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode)`	Anexa o documento especificado ao final deste documento.
`AppendDocument(srcDoc: Document, importFormatMode: ImportFormatMode, importFormatOptions: ImportFormatOptions)`	Anexa o documento especificado ao final deste documento.
`Save(fileName: string)`	Salva o documento.
`Save(fileName: string, saveFormat: SaveFormat)`	Salva o documento em um arquivo no formato especificado.
`Save(fileName: string, saveOptions: SaveOptions)`	Salva o documento em um arquivo usando as opções de salvamento especificadas.
`Save(stream: Stream, saveFormat: SaveFormat)`	Sobrecargas permitem salvar um documento em um nome de arquivo ou em um fluxo, opcionalmente especificando um formato de salvamento ou opções detalhadas de salvamento
`Save(stream: Stream, saveOptions: SaveOptions)`	Chama Save(stream, saveOptions) nesta instância de Document.
`Save(response: HttpResponse, fileName: string, contentDisposition: ContentDisposition, saveOptions: SaveOptions)`	Envia o documento ao navegador do cliente.
`EnsureMinimum()`	Se o documento não contiver seções, cria uma seção com um parágrafo.
`AcceptAllRevisions()`	Aceita todas as alterações rastreadas no documento.
`Protect(type: ProtectionType)`	Protege o documento contra alterações.
`Protect(type: ProtectionType, password: string)`	Protege o documento contra alterações e, opcionalmente, define uma senha de proteção.
`Unprotect()`	Remove a proteção do documento.
`Unprotect(password: string)`	Remove a proteção do documento se uma senha correta for especificada.
`UpdateTableLayout()`	Implementa uma abordagem anterior para o recálculo da largura das colunas da tabela que tem problemas conhecidos.
`UpdateListLabels()`	Atualiza os rótulos da lista para todos os itens da lista no documento.
`UpdateActualReferenceMarks()`	Atualiza a propriedade ActualReferenceMark de todas as notas de rodapé e notas finais no documento.
`RemoveMacros()`	Remove todas as macros (o projeto VBA) bem como barras de ferramentas e personalizações de comandos do documento.
`UpdateFields()`	Atualiza os valores dos campos em todo o documento.
`UnlinkFields()`	Desvincula os campos em todo o documento.
`NormalizeFieldTypes()`	Altera os valores do tipo de campo FieldType de FieldStart, FieldSeparator, FieldEnd em todo o documento para que correspondam aos tipos de campo contidos nos códigos de campo.
`JoinRunsWithSameFormatting()`	Mescla execuções com a mesma formatação em todos os parágrafos do documento.
`ExpandTableStylesToDirectFormatting()`	Converte a formatação especificada nos estilos de tabela em formatação direta nas tabelas do documento.
`Cleanup()`	Limpa estilos e listas não utilizados do documento.
`Cleanup(options: CleanupOptions)`	Limpa estilos e listas não utilizados do documento dependendo do CleanupOptions fornecido.
`RemoveExternalSchemaReferences()`	Remove referências externas ao esquema XML deste documento.
`StartTrackRevisions(author: string, dateTime: DateTime)`	Inicia a marcação automática de todas as alterações subsequentes que você fizer no documento programaticamente como alterações de revisão.
`StartTrackRevisions(author: string)`	Inicia a marcação automática de todas as alterações subsequentes que você fizer no documento programaticamente como alterações de revisão.
`StopTrackRevisions()`	Interrompe a marcação automática de alterações do documento como revisões.
`CopyStylesFromTemplate(template: string)`	Copia estilos do modelo especificado para um documento.
`CopyStylesFromTemplate(template: Document)`	Copia estilos do modelo especificado para um documento.
`ImportNode(srcNode: Node, isImportChildren: bool)`	Importa um nó de outro documento para o documento atual.
`GetText()`	Obtém o texto deste nó e de todos os seus filhos.
`GetChildNodes(nodeType: NodeType, isDeep: bool)`	Retorna uma coleção de nós filhos que correspondem ao tipo especificado.
`GetChild(nodeType: NodeType, index: int, isDeep: bool)`	Retorna o N-ésimo nó filho que corresponde ao tipo especificado.
`SelectNodes(xpath: string)`	Seleciona uma lista de nós que correspondem à expressão XPath.
`SelectSingleNode(xpath: string)`	Seleciona o primeiro Node que corresponde à expressão XPath.
`GetEnumerator()`	Fornece suporte para a iteração no estilo for each sobre os nós filhos deste nó.
`AppendChild(newChild: T)`	Adiciona o nó especificado ao final da lista de nós filhos deste nó.
`PrependChild(newChild: T)`	Adiciona o nó especificado ao início da lista de nós filhos deste nó.
`InsertAfter(newChild: T, refChild: Node)`	Insere o nó especificado imediatamente após o nó de referência especificado.
`InsertBefore(newChild: T, refChild: Node)`	Insere o nó especificado imediatamente antes do nó de referência especificado.
`RemoveChild(oldChild: T)`	Remove o nó filho especificado.
`RemoveAllChildren()`	Remove todos os nós filhos do nó atual.
`RemoveSmartTags()`	Remove todos os nós descendentes SmartTag do nó atual.
`IndexOf(child: Node)`	Retorna o índice do nó filho especificado no array de nós filhos.
`CreateNavigator()`	Cria um navegador que pode ser usado para percorrer e ler nós.
`GetAncestor(ancestorType: Type)`	Obtém o primeiro ancestral do tipo de objeto especificado.
`GetAncestorOf()`	Chama GetAncestorOf nesta instância de Document.
`Remove()`	Remove a si mesmo do elemento pai.
`NextPreOrder(rootNode: Node)`	Obtém o próximo nó de acordo com o algoritmo de travessia em pré-ordem da árvore.
`PreviousPreOrder(rootNode: Node)`	Obtém o nó anterior de acordo com o algoritmo de travessia em pré-ordem da árvore.
`ToString(saveFormat: SaveFormat)`	Exporta o conteúdo do nó para uma string no formato especificado.
`NodeTypeToString(nodeType: NodeType)`	Um método utilitário que converte um valor enum de tipo de nó em uma string amigável ao usuário.

Ver também

Aspose.Words for .NET — Enterprise API Reference