Document
Document class
Representerar ett Word-dokument.
För att lära dig mer, besökArbeta med dokument dokumentationsartikel.
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. Identifierar automatiskt filformatet. |
| Document(string) | Öppnar ett befintligt dokument från en fil. Identifierar automatiskt filformatet. |
| Document(Stream, LoadOptions) | Öppnar ett befintligt dokument från en ström. Gör det möjligt att ange ytterligare alternativ, till exempel ett krypteringslösenord. |
| Document(string, LoadOptions) | Öppnar ett befintligt dokument från en fil. Gör det möjligt att ange ytterligare alternativ, till exempel ett krypteringslösenord. |
Egenskaper
| namn | Beskrivning |
|---|---|
| AttachedTemplate { get; set; } | Hämtar eller anger den fullständiga sökvägen till mallen som är bifogad till dokumentet. |
| AutomaticallyUpdateStyles { get; set; } | Hämtar eller anger en flagga som anger om formaten i dokumentet uppdateras för att matcha formaten i den bifogade mallen varje gång dokumentet öppnas i MS Word. |
| BackgroundShape { get; set; } | Hämtar eller ställer in dokumentets bakgrundsform. Kan varanull . |
| Bibliography { get; } | HämtarBibliographyobjekt som representerar listan över källor som finns tillgängliga i dokumentet. |
| BuiltInDocumentProperties { get; } | Returnerar en samling som representerar alla inbyggda dokumentegenskaper i dokumentet. |
| CompatibilityOptions { get; } | Ger åtkomst till dokumentkompatibilitetsalternativ (det vill säga användarinställningarna som angetts påKompatibilitet fliken avAlternativdialogruta i Word). |
| Compliance { get; } | Hämtar OOXML-efterlevnadsversionen som bestäms från det laddade dokumentinnehållet. Gäller endast 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 punkter) mellan standardtabbstoppen. |
| DigitalSignatures { get; } | Hämtar samlingen av digitala signaturer för detta dokument och deras valideringsresultat. |
| override Document { get; } | Hämtar denna instans. |
| EndnoteOptions { get; } | Ger alternativ som styr numrering och placering av slutnoter i det här dokumentet. |
| FieldOptions { get; } | Får enFieldOptions objekt som representerar alternativ för att styra fälthantering i dokumentet. |
| FirstChild { get; } | Hämtar nodens första barn. |
| FirstSection { get; } | Hämtar det första avsnittet i dokumentet. |
| FontInfos { get; } | Ger åtkomst till egenskaper för teckensnitt som används i detta dokument. |
| FontSettings { get; set; } | Hämtar eller ställer in dokumentets teckensnittsinställningar. |
| FootnoteOptions { get; } | Ger alternativ som styr numrering och placering av fotnoter i det här dokumentet. |
| FootnoteSeparators { get; } | Ger åtkomst till fotnots-/slutnotsavgränsare som definierats i dokumentet. |
| Frameset { get; } | Returnerar enFrameset exempel om detta dokument representerar en ramsida. |
| GlossaryDocument { get; set; } | Hämtar eller ställer in ordlistadokumentet i detta dokument eller denna mall. Ett ordlistadokument är ett lagringsutrymme för AutoText-, Autokorrigerings- och Byggblocksposter som definierats i ett dokument. |
| GrammarChecked { get; set; } | Returersann om dokumentet har kontrollerats med avseende på grammatik. |
| HasChildNodes { get; } | Returersann om den här noden har några undernoder. |
| HasMacros { get; } | Returersann om dokumentet har ett VBA-projekt (makron). |
| HasRevisions { get; } | Returersann om dokumentet har några spårade ändringar. |
| HyphenationOptions { get; } | Ger åtkomst till alternativ för avstavning i dokumentet. |
| IncludeTextboxesFootnotesEndnotesInStat { get; set; } | Anger om textrutor, fotnoter och slutnoter ska inkluderas i ordräkningsstatistiken. |
| override IsComposite { get; } | Returersann eftersom denna nod kan ha underordnade noder. |
| JustificationMode { get; set; } | Hämtar eller ställer in justeringen av teckenavståndet för ett dokument. |
| LastChild { get; } | Hämtar nodens sista barn. |
| LastSection { get; } | Hämtar det sista avsnittet i dokumentet. |
| LayoutOptions { get; } | Får enLayoutOptions objekt som representerar alternativ för att styra layoutprocessen för detta dokument. |
| Lists { get; } | Ger åtkomst till listformateringen som används i dokumentet. |
| MailMerge { get; } | Returnerar enMailMerge objekt som representerar dokumentkopplingsfunktionen för dokumentet. |
| MailMergeSettings { get; set; } | Hämtar eller anger objektet som innehåller all information om dokumentkoppling för ett dokument. |
| NextSibling { get; } | Hämtar noden som följer direkt efter denna nod. |
| NodeChangingCallback { get; set; } | Anropas när en nod infogas eller tas bort i dokumentet. |
| override NodeType { get; } | ReturerDocument . |
| OriginalFileName { get; } | Hämtar dokumentets ursprungliga filnamn. |
| OriginalLoadFormat { get; } | Hämtar formatet för originaldokumentet som laddades in i det här objektet. |
| 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 dokumentets sidfärg. Den här egenskapen är en enklare version avBackgroundShape . |
| PageCount { get; } | Hämtar antalet sidor i dokumentet beräknat med den senaste sidlayoutoperationen. |
| ParentNode { get; } | Hämtar den omedelbara föräldern till denna nod. |
| PreviousSibling { get; } | Hämtar noden som omedelbart föregår denna nod. |
| ProtectionType { get; } | Hämtar den aktiva dokumentskyddstypen. |
| PunctuationKerning { get; set; } | Anger om kerning gäller för både latinsk text och interpunktion. |
| Range { get; } | Returnerar enRangeobjekt som representerar den del av ett dokument som finns i denna nod. |
| RemovePersonalInformation { get; set; } | Hämtar eller anger en flagga som anger att Microsoft Word tar 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 anger ett värde som anger om man ska arbeta med originalversionen eller den reviderade versionen av ett dokument. |
| Sections { get; } | Returnerar en samling som representerar alla avsnitt i dokumentet. |
| ShadeFormData { get; set; } | Anger om grå skuggning ska aktiveras i formulärfält. |
| ShowGrammaticalErrors { get; set; } | Anger om grammatikfel ska visas i det här dokumentet. |
| ShowSpellingErrors { get; set; } | Anger om stavfel ska visas i det här dokumentet. |
| SpellingChecked { get; set; } | Returersann om dokumentet har stavningskontrollerats. |
| Styles { get; } | Returnerar en samling stilar definierade i dokumentet. |
| Theme { get; } | HämtarTheme objekt för detta dokument. |
| TrackRevisions { get; set; } | Sant om ändringar spåras när dokumentet redigeras i Microsoft Word. |
| Variables { get; } | Returnerar samlingen av variabler som lagts till i ett dokument eller en mall. |
| VbaProject { get; set; } | Hämtar eller ställer in 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 förlust av data- eller formateringsåtergivning. |
| Watermark { get; } | Ger åtkomst till dokumentets vattenstämpel. |
| WebExtensionTaskPanes { get; } | Returnerar en samling som representerar en lista med tillägg i åtgärdsfönstret. |
| WriteProtection { get; } | Ger åtkomst till dokumentets skrivskyddsalternativ. |
Metoder
| namn | Beskrivning |
|---|---|
| override Accept(DocumentVisitor) | Tar emot en besökare. |
| AcceptAllRevisions() | Accepterar alla spårade ändringar i dokumentet. |
| override AcceptEnd(DocumentVisitor) | Accepterar en besökare för att besöka slutet av dokumentet. |
| override AcceptStart(DocumentVisitor) | Accepterar en besökare för att besöka början av dokumentet. |
| AppendChild<T>(T) | 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 format och listor från dokumentet. |
| Cleanup(CleanupOptions) | Rensar oanvända stilar och listor från dokumentet beroende på angivetCleanupOptions . |
| Clone() | Utför en djup kopiering avDocument . |
| Clone(bool) | Skapar en duplikat av noden. |
| Compare(Document, string, DateTime) | Jämför detta dokument med ett annat dokument som producerar ändringar, baserat på antalet redigeringar och formateringsrevisioner.Revision . |
| Compare(Document, string, DateTime, CompareOptions) | Jämför detta dokument med ett annat dokument som producerar ändringar som ett antal redigerings- och formateringsrevisionerRevision . 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() | Skapar en navigator som kan användas för att korsa och läsa noder. |
| EnsureMinimum() | Om dokumentet inte innehåller några avsnitt skapas ett avsnitt med ett stycke. |
| ExpandTableStylesToDirectFormatting() | Konverterar formatering som anges i tabellformat till direkt formatering på tabeller i dokumentet. |
| ExtractPages(int, int) | ReturnerarDocument objekt som representerar ett angivet sidintervall. |
| 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 live-samling av underordnade noder som matchar den angivna typen. |
| GetEnumerator() | Ger stöd för iterationen för varje stil över de underordnade noderna till 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 noder. |
| 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 undernodsmatrisen. |
| InsertAfter<T>(T, Node) | Infogar den angivna noden omedelbart efter den angivna referensnoden. |
| InsertBefore<T>(T, Node) | Infogar den angivna noden omedelbart före den angivna referensnoden. |
| JoinRunsWithSameFormatting() | Kopplar samman körningar med samma formatering i alla stycken i dokumentet. |
| NextPreOrder(Node) | Hämtar nästa nod enligt algoritmen för förbeställningsträdtraversering. |
| NormalizeFieldTypes() | Ändrar fälttypvärdenFieldType avFieldStart ,FieldSeparator ,FieldEnd i hela dokumentet så att de motsvarar fälttyperna som finns i fältkoderna. |
| PrependChild<T>(T) | 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 trädtraversering i förbeställning. |
| Print() | Skriver ut hela dokumentet till standardskrivaren. |
| Print(PrinterSettings) | Skriver ut dokumentet enligt de angivna skrivarinställningarna, med hjälp av standardutskriftskontrollen (inget användargränssnitt). |
| Print(string) | Skriv ut hela dokumentet till den angivna skrivaren, med hjälp av standardutskriftskontrollen (inget användargränssnitt). |
| Print(PrinterSettings, string) | Skriver ut dokumentet enligt de angivna skrivarinställningarna, med hjälp av standardutskriftskontrollen (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 ställer in ett lösenord om så önskas. |
| Remove() | Tar bort sig själv från föräldern. |
| RemoveAllChildren() | Tar bort alla undernoder till den aktuella noden. |
| RemoveBlankPages() | Tar bort tomma sidor från dokumentet. |
| RemoveChild<T>(T) | Tar bort den angivna undernoden. |
| 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 underordnade noder till den aktuella noden. |
| RenderToScale(int, Graphics, float, float, float) | Återger en dokumentsida till enGraphics objekt i en specificerad skala. |
| RenderToSize(int, Graphics, float, float, float, float) | Återger en dokumentsida till enGraphics objekt till en specificerad storlek. |
| Save(string) | Sparar dokumentet till en fil. Bestämmer automatiskt sparformatet från filändelsen. |
| Save(Stream, SaveFormat) | Sparar dokumentet till en ström med det angivna formatet. |
| Save(Stream, SaveOptions) | Sparar dokumentet till en ström med de angivna sparalternativen. |
| Save(string, SaveFormat) | Sparar dokumentet till en fil i det angivna formatet. |
| 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örstaNode 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 nodens innehåll till en sträng i det angivna formatet. |
| ToString(SaveOptions) | Exporterar nodens innehåll till en sträng med de angivna sparalternativen. |
| UnlinkFields() | Avlänkar fält i hela dokumentet. |
| Unprotect() | Tar bort skyddet från dokumentet oavsett lösenordet. |
| Unprotect(string) | Tar bort skyddet från dokumentet om ett korrekt lösenord anges. |
| UpdateActualReferenceMarks() | UppdaterarActualReferenceMark egenskap för alla fotnoter och slutnoter i dokumentet. |
| UpdateFields() | Uppdaterar värdena för fält i hela dokumentet. |
| UpdateListLabels() | Uppdaterar listetiketter för alla listobjekt i dokumentet. |
| UpdatePageLayout() | Återskapar dokumentets sidlayout. |
| UpdateThumbnail() | UppdateringarThumbnail av dokumentet med standardalternativen. |
| UpdateThumbnail(ThumbnailGeneratingOptions) | UppdateringarThumbnail av dokumentet enligt de angivna alternativen. |
| UpdateWordCount() | Uppdaterar dokumentets egenskaper för ordantal. |
| UpdateWordCount(bool) | Uppdaterar dokumentets ordantal, uppdaterar valfrittLines egendom. |
Anmärkningar
DeDocument ä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 ett avDocument konstruktorer. 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 SaveFormat format.
Att rita dokumentsidor direkt på enGrafik objekt use RenderToScale ellerRenderToSize metod.
För att skriva ut dokumentet, använd en avPrint metoder.
MailMergeär Aspose.Words rapporteringsmotor som gör det möjligt att snabbt och enkelt fylla rapporter utformade i Microsoft Word med data från olika datakällor. Data kan komma från en DataSet, DataTable, DataView, IDataReader eller en array med värden.Koppla ut e-post kommer att gå igenom posterna som finns i datakällan och infoga dem i fälten för koppling av dokument i dokumentet och utöka det efter behov.
Document lagrar dokumentomfattande information som t.ex.Styles , BuiltInDocumentProperties ,CustomDocumentProperties , listor och makron. De flesta av dessa objekt är tillgängliga via motsvarande egenskaper förDocument.
DeDocument ä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 likt XmlDocument. Dokumentets innehåll kan manipuleras fritt programmatiskt:
- Dokumentets noder kan nås via typade samlingar, till exempel
Sections,ParagraphCollectionetc. - Dokumentets noder kan väljas utifrån deras nodtyp med hjälp av
GetChildNodeseller med hjälp av en XPath-fråga medSelectNodesellerSelectSingleNode. - Innehållsnoder kan läggas till eller tas bort var som helst i dokumentet med hjälp av
InsertBefore,InsertAfter,RemoveChildoch andra -metoder som tillhandahålls av basklassenCompositeNode. - Formateringsattributen för varje nod kan ändras via nodens egenskaper.
Överväg att användaDocumentBuilder det förenklar uppgiften att programmatiskt skapa eller fylla i dokumentträdet.
DeDocument kan endast innehållaSection föremål.
I Microsoft Word måste ett giltigt dokument ha minst ett avsnitt.
Exempel
Visar hur man utför en dokumentkoppling 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 följer två sätt att använda en datatabell som datakälla för en dokumentkoppling.
// 1 - Använd hela tabellen för dokumentkopplingen för att skapa ett utgående dokumentkopplingsdokument 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 enda dokument för koppling av dokument:
doc = CreateSourceDocExecuteDataTable();
doc.MailMerge.Execute(table.Rows[1]);
doc.Save(ArtifactsDir + "MailMerge.ExecuteDataTable.OneRow.docx");
}
/// <summary>
/// Skapar ett källdokument för dokumentkoppling.
/// </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
- class DocumentBase
- namnutrymme Aspose.Words
- hopsättning Aspose.Words