MailMergeSettings

MailMergeSettings class

Anger all kopplingsinformation för ett dokument.

public class MailMergeSettings

Konstruktörer

namn Beskrivning
MailMergeSettings() Default_Constructor

Egenskaper

namn Beskrivning
ActiveRecord { get; set; } Anger det enbaserade indexet för posten från datakällan som ska visas i Microsoft Word. Standardvärdet är 1.
AddressFieldName { get; set; } Anger kolumnen i datakällan som innehåller e-postadresser. Standardvärdet är en tom sträng.
CheckErrors { get; set; } Anger vilken typ av felrapportering som ska utföras av Microsoft Word när en sammankoppling av e-post utförs. Standardvärdet ärDefault .
ConnectString { get; set; } Anger anslutningssträngen som används för att ansluta till en extern datakälla. Standardvärdet är en tom sträng.
DataSource { get; set; } Anger sökvägen till kopplingsdatakällan. Standardvärdet är en tom sträng.
DataType { get; set; } Anger typen av kopplingsdatakällan och metoden för dataåtkomst. Standardvärdet ärDefault .
Destination { get; set; } Anger hur Microsoft Word kommer att mata ut resultaten av en e-postsammanfogning. Standardvärdet ärDefault .
DoNotSupressBlankLines { get; set; } Anger hur ett program som utför kopplingen ska hantera tomma rader i de sammanslagna dokumenten som är resultatet av kopplingen. Standardvärdet ärfalsk .
HeaderSource { get; set; } Anger sökvägen till källan för kopplingshuvudet. Standardvärdet är en tom sträng.
LinkToQuery { get; set; } Inte säker på den här. Microsoft Word Automation Reference föreslår att denna anger att frågan exekveras varje gång dokumentet öppnas i Microsoft Word. Men OOXML-specifikationen antyder att denna anger att frågan innehåller en referens till en extern frågefil som innehåller den faktiska frågan. Standardvärdet ärfalsk .
MailAsAttachment { get; set; } Anger att dokumenten som skapas under en sammankopplingsåtgärd ska skickas som en bilaga via e-post snarare än själva e-postmeddelandets brödtext. Standardvärdet ärfalsk .
MailSubject { get; set; } Anger texten som ska visas i ämnesraden för e-postmeddelanden eller fax som produceras under sammanslagningen. Standardvärdet är en tom sträng.
MainDocumentType { get; set; } Anger huvuddokumenttypen för sammankoppling. Standardvärdet ärDefault .
Odso { get; set; } Hämtar eller ställer in objektet som anger ODSO-inställningarna (Office Data Source Object).
Query { get; set; } Innehåller Structured Query Language-strängen som ska köras mot den angivna externa datakällan för att returnera den uppsättning poster som ska importeras till dokumentet när kopplingsoperationen utförs. Standardvärdet är en tom sträng.
ViewMergedData { get; set; } Anger att Microsoft Word ska visa data från den angivna externa datakällan där sammanslagningsfälten har infogats (t.ex. förhandsgranska sammanslagna data). Standardvärdet ärfalsk .

Metoder

namn Beskrivning
Clear() Rensar inställningarna för sammankoppling av dokument på ett sådant sätt att när dokumentet sparas, kommer inga sammanslagningsinställningar att sparas och det blir ett normalt dokument.
Clone() Returnerar en djup klon av detta objekt.

Anmärkningar

Du kan använda det här objektet för att ange en kopplingsdatakälla för ett dokument och denna information (tillsammans med de tillgängliga datafälten) kommer att visas i Microsoft Word när användaren öppnar det här dokumentet. Eller så kan du använda det här objektet för att fråga inställningar för koppling av e-post som användaren har angett i Microsoft Word för detta dokument.

Du behöver normalt inte skapa objekt av den här klassen direkt eftersom inställningar för koppling av dokument för ett dokument alltid är tillgängliga viaMailMergeSettings fast egendom.

För att upptäcka om det här dokumentet är ett huvuddokument för sammankoppling av e-post, kontrollera värdet på MainDocumentType fast egendom.

För att ta bort sammanslagningsinställningar och datakällainformation från ett dokument kan du använda Clear metod. Aspose.Words kommer inte att skriva sammanslagningsinställningar till ett dokument om MainDocumentType egenskapen är inställd påNotAMergeDocument ellerDataType egenskapen är inställd påNone.

Det bästa sättet att lära sig hur man använder egenskaperna för detta objekt är att skapa ett dokument med en önskad -datakälla manuellt i Microsoft Word och sedan öppna det dokumentet med Aspose.Words och undersöka egenskaperna förMailMergeSettings ochOdso objekt. Det här är ett bra tillvägagångssätt om du till exempel vill lära dig hur du programmatiskt konfigurerar en datakälla.

Aspose.Words bevarar kopplingsinformation när du laddar, sparar och konverterar documents mellan olika format, men använder inte denna information när du utför sin egen kopplingsinformation med hjälp avMailMerge objekt.

Exempel

Visar hur man kör en sammankoppling med data från ett Office-datakällobjekt.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Write("Dear ");
builder.InsertField("MERGEFIELD FirstName", "<FirstName>");
builder.Write(" ");
builder.InsertField("MERGEFIELD LastName", "<LastName>");
builder.Writeln(": ");
builder.InsertField("MERGEFIELD Message", "<Message>");

// Skapa en datakälla i form av en ASCII-fil, med "|" karaktär
// fungerar som avgränsaren som separerar kolumner. Den första raden innehåller de tre kolumnernas namn,
// och varje efterföljande rad är en rad med sina respektive värden.
string[] lines = { "FirstName|LastName|Message",
    "John|Doe|Hello! This message was created with Aspose Words mail merge." };
string dataSrcFilename = ArtifactsDir + "MailMerge.MailMergeSettings.DataSource.txt";

File.WriteAllLines(dataSrcFilename, lines);

MailMergeSettings settings = doc.MailMergeSettings;
settings.MainDocumentType = MailMergeMainDocumentType.MailingLabels;
settings.CheckErrors = MailMergeCheckErrors.Simulate;
settings.DataType = MailMergeDataType.Native;
settings.DataSource = dataSrcFilename;
settings.Query = "SELECT * FROM " + doc.MailMergeSettings.DataSource;
settings.LinkToQuery = true;
settings.ViewMergedData = true;

Assert.AreEqual(MailMergeDestination.Default, settings.Destination);
Assert.False(settings.DoNotSupressBlankLines);

Odso odso = settings.Odso;
odso.DataSource = dataSrcFilename;
odso.DataSourceType = OdsoDataSourceType.Text;
odso.ColumnDelimiter = '|';
odso.FirstRowContainsColumnNames = true;

Assert.AreNotSame(odso, odso.Clone());
Assert.AreNotSame(settings, settings.Clone());

// Att öppna detta dokument i Microsoft Word kommer att köra sammanslagningen innan innehållet visas. 
doc.Save(ArtifactsDir + "MailMerge.MailMergeSettings.docx");

Se även