Document

Document class

Representerar ett Word-dokument.

public class Document : DocumentBase

Konstruktörer

namn Beskrivning
Document() Skapar ett tomt Word-dokument.
Document(Stream) Öppnar ett befintligt dokument från en ström. Upptäcker automatiskt filformatet.
Document(string) Öppnar ett befintligt dokument från en fil. Upptäcker automatiskt filformatet.
Document(Stream, LoadOptions) Öppnar ett befintligt dokument från en ström. Tillåter att ange ytterligare alternativ såsom ett krypteringslösenord.
Document(string, LoadOptions) Öppnar ett befintligt dokument från en fil. Tillåter att ange ytterligare alternativ såsom ett krypteringslösenord.

Egenskaper

namn Beskrivning
AttachedTemplate { get; set; } Hämtar eller ställer in hela sökvägen för mallen som är bifogad till dokumentet.
AutomaticallyUpdateStyles { get; set; } Hämtar eller ställer in en flagga som anger om stilarna i dokumentet uppdateras för att matcha stilarna i den bifogade mallen varje gång dokumentet öppnas i MS Word.
BackgroundShape { get; set; } Hämtar eller ställer in bakgrundsformen för dokumentet. Kan vara null.
BuiltInDocumentProperties { get; } Returnerar en samling som representerar alla inbyggda dokumentegenskaper i dokumentet.
ChildNodes { get; } Hämtar alla omedelbara underordnade noder för denna nod.
CompatibilityOptions { get; } Ger tillgång till dokumentkompatibilitetsalternativ (det vill säga användarinställningarna som anges på Kompatibilitet fliken i alternativ dialog i Word).
Compliance { get; } Får OOXML-kompatibilitetsversionen fastställd från det inlästa dokumentinnehållet. Är meningsfullt endast för OOXML-dokument.
Count { get; } Hämtar antalet omedelbara barn till denna nod.
CustomDocumentProperties { get; } Returnerar en samling som representerar alla anpassade dokumentegenskaper för dokumentet.
CustomNodeId { get; set; } Anger anpassad nodidentifierare.
CustomXmlParts { get; set; } Hämtar eller ställer in samlingen av anpassade XML-datalagringsdelar.
DefaultTabStop { get; set; } Hämtar eller ställer in intervallet (i poäng) mellan standardtabbstoppen.
DigitalSignatures { get; } Hämtar insamlingen av digitala signaturer för detta dokument och deras valideringsresultat.
override Document { get; }
EndnoteOptions { get; } Ger alternativ som styr numrering och placering av slutnoter i detta dokument.
FieldOptions { get; } Får en Fältalternativobjekt som representerar alternativ för att styra fälthanteringen i dokumentet.
FirstChild { get; } Får det första barnet i noden.
FirstSection { get; } Hämtar det första avsnittet i dokumentet.
FontInfos { get; } Ger tillgång till egenskaperna för teckensnitt som används i detta dokument.
FontSettings { get; set; } Hämtar eller ställer in dokumentfontinställningar.
FootnoteOptions { get; } Ger alternativ som styr numrering och placering av fotnoter i detta dokument.
Frameset { get; } Returnerar enFramesetinstans om detta dokument representerar en ramsida.
GlossaryDocument { get; set; } Hämtar eller ställer in ordlistans dokument i detta dokument eller mall. Ett ordlistadokument är en storage för AutoText, AutoCorrect och Building Block-poster definierade i ett dokument.
GrammarChecked { get; set; } Returnerar Sann om dokumentet har kontrollerats för grammatik.
HasChildNodes { get; } Returnerar sant om denna nod har några underordnade noder.
HasMacros { get; } Returnerar Sann om dokumentet har ett VBA-projekt (makron).
HasRevisions { get; } Returnerar Sann om dokumentet har några spårade ändringar.
HyphenationOptions { get; } Ger tillgång till alternativ för dokumentavstavning.
override IsComposite { get; } Returnerar sant eftersom denna nod kan ha underordnade noder.
LastChild { get; } Hämtar nodens sista underordnade.
LastSection { get; } Hämtar det sista avsnittet i dokumentet.
LayoutOptions { get; } Får en Layoutalternativ objekt som representerar alternativ för att styra layoutprocessen för detta dokument.
Lists { get; } Ger tillgång till listformateringen som används i dokumentet.
MailMerge { get; } Returnerar en MailMerge objekt som representerar kopplingsfunktionen för dokumentet.
MailMergeSettings { get; set; } Hämtar eller ställer in objektet som innehåller all kopplingsinformation för ett dokument.
NextSibling { get; } Hämtar noden omedelbart efter denna nod.
NodeChangingCallback { get; set; } Anropas när en nod infogas eller tas bort i dokumentet.
override NodeType { get; } Returnerar NodeType.Document .
OriginalFileName { get; } Hämtar originalfilnamnet för dokumentet.
OriginalLoadFormat { get; } Hämtar formatet för originaldokumentet som laddades in i detta objekt.
PackageCustomParts { get; set; } Hämtar eller ställer in samlingen av anpassade delar (godtyckligt innehåll) som är länkade till OOXML-paketet med hjälp av “okända relationer”.
PageColor { get; set; } Hämtar eller ställer in sidfärgen på dokumentet. Den här egenskapen är en enklare version avBackgroundShape .
PageCount { get; } Hämtar antalet sidor i dokumentet som beräknats av den senaste sidlayoutoperationen.
ParentNode { get; } Hämtar den omedelbara föräldern till denna nod.
PreviousSibling { get; } Hämtar noden omedelbart före denna nod.
ProtectionType { get; } Får den för närvarande aktiva dokumentskyddstypen.
Range { get; } Returnerar en Räckvidd objekt som representerar den del av ett dokument som finns i denna nod.
RemovePersonalInformation { get; set; } Hämtar eller ställer in en flagga som indikerar att Microsoft Word kommer att ta bort all användarinformation från kommentarer, revisioner och dokumentegenskaper när dokumentet sparas.
ResourceLoadingCallback { get; set; } Gör det möjligt att styra hur externa resurser laddas.
Revisions { get; } Hämtar en samling revisioner (spårade ändringar) som finns i detta dokument.
RevisionsView { get; set; } Hämtar eller ställer in ett värde som indikerar om man ska arbeta med den ursprungliga eller reviderade versionen av ett dokument.
Sections { get; } Returnerar en samling som representerar alla avsnitt i dokumentet.
ShadeFormData { get; set; } Anger om den grå skuggningen ska aktiveras i formulärfält.
ShowGrammaticalErrors { get; set; } Anger om grammatikfel ska visas i detta dokument.
ShowSpellingErrors { get; set; } Anger om stavfel ska visas i detta dokument.
SpellingChecked { get; set; } Returnerar Sann om dokumentet har stavningskontrollerats.
Styles { get; } Returnerar en samling stilar definierade i dokumentet.
Theme { get; } FårTheme objekt för detta dokument.
TrackRevisions { get; set; } Sann om ändringar spåras när detta dokument redigeras i Microsoft Word.
Variables { get; } Returnerar samlingen av variabler som lagts till i ett dokument eller mall.
VbaProject { get; set; } Hämtar eller sätter enVbaProject .
VersionsCount { get; } Hämtar antalet dokumentversioner som lagrades i DOC-dokumentet.
ViewOptions { get; } Ger alternativ för att styra hur dokumentet visas i Microsoft Word.
WarningCallback { get; set; } Anropas under olika dokumentbehandlingsprocedurer när ett problem upptäcks som kan resultera i data- eller formateringsförlust.
Watermark { get; } Ger åtkomst till dokumentets vattenstämpel.
WebExtensionTaskPanes { get; } Returnerar en samling som representerar en lista över tillägg i aktivitetsfönstret.
WriteProtection { get; } Ger åtkomst till alternativen för dokumentskrivskydd.

Metoder

namn Beskrivning
override Accept(DocumentVisitor) Accepterar en besökare.
AcceptAllRevisions() Accepterar alla spårade ändringar i dokumentet.
AppendChild(Node) Lägger till den angivna noden i slutet av listan över underordnade noder för denna nod.
AppendDocument(Document, ImportFormatMode) Lägger till det angivna dokumentet i slutet av detta dokument.
AppendDocument(Document, ImportFormatMode, ImportFormatOptions) Lägger till det angivna dokumentet i slutet av detta dokument.
Cleanup() Rensar oanvända stilar och listor från dokumentet.
Cleanup(CleanupOptions) Rensar oanvända stilar och listor från dokumentet beroende på givetCleanupOptions .
Clone() Utför en djup kopia avDocument .
Clone(bool) Skapar en dubblett av noden.
Compare(Document, string, DateTime) Jämför detta dokument med ett annat dokument som ger ändringar som antal redigeringar och formatrevisionerRevision .
Compare(Document, string, DateTime, CompareOptions) Jämför detta dokument med ett annat dokument som ger ändringar som ett antal redigerings- och formatrevisionerRevision . Gör det möjligt att ange jämförelsealternativ med hjälp avCompareOptions .
CopyStylesFromTemplate(Document) Kopierar stilar från den angivna mallen till ett dokument.
CopyStylesFromTemplate(string) Kopierar stilar från den angivna mallen till ett dokument.
CreateNavigator() Reserverad för systemanvändning. IXPathNavigable.
EnsureMinimum() Om dokumentet inte innehåller några avsnitt skapas ett avsnitt med ett stycke.
ExpandTableStylesToDirectFormatting() Konverterar formatering som anges i tabellstilar till direkt formatering på tabeller i dokumentet.
ExtractPages(int, int) ReturnerarDocument objekt som representerar specificerat intervall av sidor.
GetAncestor(NodeType) Hämtar den första förfadern till den angivnaNodeType .
GetAncestor(Type) Hämtar den första förfadern till den angivna objekttypen.
GetChild(NodeType, int, bool) Returnerar en N:te underordnad nod som matchar den angivna typen.
GetChildNodes(NodeType, bool) Returnerar en aktiv samling av underordnade noder som matchar den angivna typen.
GetEnumerator() Tillhandahåller stöd för varje stiliteration över undernoderna för denna nod.
GetPageInfo(int) Hämtar sidstorlek, orientering och annan information om en sida som kan vara användbar för utskrift eller rendering.
override GetText() Hämtar texten för denna nod och alla dess underordnade.
ImportNode(Node, bool) Importerar en nod från ett annat dokument till det aktuella dokumentet.
ImportNode(Node, bool, ImportFormatMode) Importerar en nod från ett annat dokument till det aktuella dokumentet med ett alternativ för att styra formateringen.
IndexOf(Node) Returnerar indexet för den angivna undernoden i den underordnade nodmatrisen.
InsertAfter(Node, Node) Infogar den angivna noden omedelbart efter den angivna referensnoden.
InsertBefore(Node, Node) Infogar den angivna noden omedelbart före den angivna referensnoden.
JoinRunsWithSameFormatting() Sammanfogar körningar med samma formatering i alla stycken i dokumentet.
NextPreOrder(Node) Hämtar nästa nod enligt algoritmen för förbeställningsträdet.
NormalizeFieldTypes() Ändrar fälttypvärdenFieldType avFieldStart ,FieldSeparator ,FieldEnd i hela dokumentet så att de motsvarar fälttyperna som finns i fältkoderna.
PrependChild(Node) Lägger till den angivna noden i början av listan över underordnade noder för denna nod.
PreviousPreOrder(Node) Hämtar föregående nod enligt algoritmen för förbeställningsträdet.
Print() Skriver ut hela dokumentet till standardskrivaren.
Print(PrinterSettings) Skriver ut dokumentet enligt de angivna skrivarinställningarna, med standardutskriftskontrollern (utan användargränssnitt).
Print(string) Skriv ut hela dokumentet till den angivna skrivaren, med standardutskriftskontrollern (inget användargränssnitt).
Print(PrinterSettings, string) Skriver ut dokumentet enligt de angivna skrivarinställningarna, med standardutskriftskontrollern (inget användargränssnitt) och ett dokumentnamn.
Protect(ProtectionType) Skyddar dokumentet från ändringar utan att ändra det befintliga lösenordet eller tilldelar ett slumpmässigt lösenord.
Protect(ProtectionType, string) Skyddar dokumentet från ändringar och anger valfritt ett skyddslösenord.
Remove() Tar bort sig själv från föräldern.
RemoveAllChildren() Tar bort alla undernoder för den aktuella noden.
RemoveChild(Node) Tar bort den angivna underordnade noden.
RemoveExternalSchemaReferences() Tar bort externa XML-schemareferenser från detta dokument.
RemoveMacros() Tar bort alla makron (VBA-projektet) samt verktygsfält och kommandoanpassningar från dokumentet.
RemoveSmartTags() Tar bort allaSmartTag underliggande noder till den aktuella noden.
RenderToScale(int, Graphics, float, float, float) Gör en dokumentsida till enGraphics objekt i en angiven skala.
RenderToSize(int, Graphics, float, float, float, float) Gör en dokumentsida till enGraphics objekt till en angiven storlek.
Save(string) Sparar dokumentet till en fil. Bestämmer automatiskt sparformatet från tillägget.
Save(Stream, SaveFormat) Sparar dokumentet i en ström med det angivna formatet.
Save(Stream, SaveOptions) Sparar dokumentet i en ström med de angivna sparalternativen.
Save(string, SaveFormat) Sparar dokumentet till en fil i angivet format.
Save(string, SaveOptions) Sparar dokumentet till en fil med de angivna sparalternativen.
Save(HttpResponse, string, ContentDisposition, SaveOptions) Skickar dokumentet till klientens webbläsare.
SelectNodes(string) Väljer en lista med noder som matchar XPath-uttrycket.
SelectSingleNode(string) Väljer den första noden som matchar XPath-uttrycket.
StartTrackRevisions(string) Börjar automatiskt markera alla ytterligare ändringar du gör i dokumentet programmatiskt som revisionsändringar.
StartTrackRevisions(string, DateTime) Börjar automatiskt markera alla ytterligare ändringar du gör i dokumentet programmatiskt som revisionsändringar.
StopTrackRevisions() Stoppar automatisk markering av dokumentändringar som revisioner.
ToString(SaveFormat) Exporterar innehållet i noden till en sträng i angivet format.
ToString(SaveOptions) Exporterar innehållet i noden till en sträng med de angivna sparalternativen.
UnlinkFields() Tar bort länkar till fält i hela dokumentet.
Unprotect() Tar bort skyddet från dokumentet oavsett lösenord.
Unprotect(string) Tar bort skyddet från dokumentet om ett korrekt lösenord anges.
UpdateFields() Uppdaterar värdena för fält i hela dokumentet.
UpdateListLabels() Uppdaterar listetiketter för alla listobjekt i dokumentet.
UpdatePageLayout() Bygger om dokumentets sidlayout.
UpdateThumbnail() UppdateringarThumbnail av dokumentet med standardalternativ.
UpdateThumbnail(ThumbnailGeneratingOptions) UppdateringarThumbnail av dokumentet enligt de angivna alternativen.
UpdateWordCount() Uppdaterar ordräkningsegenskaper för dokumentet.
UpdateWordCount(bool) Uppdaterar ordräkningsegenskaper för dokumentet, uppdaterar eventuelltLines egenskap.

Anmärkningar

De Dokumentera är ett centralt objekt i Aspose.Words-biblioteket.

För att ladda ett befintligt dokument i någon avLoadFormat format, skicka ett filnamn eller en ström till en av Dokumentera konstruktörer. För att skapa ett tomt dokument, anropa konstruktorn utan parametrar.

Använd en av överbelastningsmetoderna för att spara dokumentet i någon av the SaveFormat format.

Att rita dokumentsidor direkt på en Grafik objekt användning RenderToScale ellerRenderToSize metod.

För att skriva ut dokumentet, använd en avPrintmetoder.

MailMerge är Aspose.Words rapportmotor som gör det möjligt att snabbt och enkelt fylla rapporter designade i Microsoft Word med data från olika datakällor. Datan kan vara från en Dataset, DataTable, DataView, IDataReader eller en uppsättning värden. MailMerge kommer att gå igenom posterna som finns i datakällan och infoga dem i e-postsammanslagningsfält i dokumentet och utöka det vid behov.

Dokumentera lagrar dokumentövergripande information som t.exStyles , BuiltInDocumentProperties ,CustomDocumentProperties , listor och makron. De flesta av dessa objekt är tillgängliga via motsvarande egenskaper för Dokumentera.

De Dokumenteraär en rotnod i ett träd som innehåller alla andra noder i dokumentet. Trädet är ett sammansatt designmönster och på många sätt liknar XmlDocument. Innehållet i dokumentet kan manipuleras fritt programmatiskt:

Överväg att användaDocumentBuilder som förenklar uppgiften att programmatiskt skapa eller fylla i dokumentträdet.

De Dokumentera kan endast innehållaSection objekt.

I Microsoft Word måste ett giltigt dokument ha minst ett avsnitt.

Exempel

Visar hur man kör en e-postsammanfogning med data från en datatabell.

public void ExecuteDataTable()
{
    DataTable table = new DataTable("Test");
    table.Columns.Add("CustomerName");
    table.Columns.Add("Address");
    table.Rows.Add(new object[] { "Thomas Hardy", "120 Hanover Sq., London" });
    table.Rows.Add(new object[] { "Paolo Accorti", "Via Monte Bianco 34, Torino" });

    // Nedan finns två sätt att använda en datatabell som datakälla för en e-postkoppling.
    // 1 - Använd hela tabellen för kopplingen för att skapa ett kopplingsdokument för varje rad i tabellen:
    Document doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.WholeTable.docx");

    // 2 - Använd en rad i tabellen för att skapa ett dokument för utmatning av dokument:
    doc = CreateSourceDocExecuteDataTable();

    doc.MailMerge.Execute(table.Rows[1]);

    doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.OneRow.docx");
}

/// <summary>
/// Skapar ett källdokument för sammankoppling av brev.
/// </summary>
private static Document CreateSourceDocExecuteDataTable()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" MERGEFIELD CustomerName ");
    builder.InsertParagraph();
    builder.InsertField(" MERGEFIELD Address ");

    return doc;
}

Se även