MailMergeSettings

MailMergeSettings class

Especifica toda la información de combinación de correspondencia para un documento.

public class MailMergeSettings

Constructores

Nombre Descripción
MailMergeSettings() Constructor predeterminado

Propiedades

Nombre Descripción
ActiveRecord { get; set; } Especifica el índice basado en uno del registro de la fuente de datos que se mostrará en Microsoft Word. El valor predeterminado es 1.
AddressFieldName { get; set; } Especifica la columna dentro del origen de datos que contiene las direcciones de correo electrónico. El valor predeterminado es una cadena vacía.
CheckErrors { get; set; } Especifica el tipo de informe de errores que realizará Microsoft Word al realizar una combinación de correspondencia. El valor predeterminado esDefault .
ConnectString { get; set; } Especifica la cadena de conexión utilizada para conectarse a una fuente de datos externa. El valor predeterminado es una cadena vacía.
DataSource { get; set; } Especifica la ruta al origen de datos de combinación de correspondencia. El valor predeterminado es una cadena vacía.
DataType { get; set; } Especifica el tipo de fuente de datos de combinación de correspondencia y el método de acceso a los datos. El valor predeterminado esDefault .
Destination { get; set; } Especifica cómo Microsoft Word generará los resultados de una combinación de correspondencia. El valor predeterminado esDefault .
DoNotSupressBlankLines { get; set; } Especifica cómo una aplicación que realiza la combinación de correspondencia manejará las líneas en blanco en los documentos combinados resultantes de la combinación de correspondencia. El valor predeterminado esfalso .
HeaderSource { get; set; } Especifica la ruta al origen del encabezado de combinación de correspondencia. El valor predeterminado es una cadena vacía.
LinkToQuery { get; set; } No estoy seguro de esto. La referencia de automatización de Microsoft Word sugiere que esto especifica que la consulta se ejecuta cada vez que se abre el documento en Microsoft Word. Pero la especificación OOXML sugiere que esto especifica que la consulta contiene una referencia a un archivo de consulta externo que contiene la consulta real. El valor predeterminado esfalso .
MailAsAttachment { get; set; } Especifica que los documentos producidos durante una operación de combinación de correo deben enviarse por correo electrónico como datos adjuntos en lugar de que el cuerpo del correo electrónico real. El valor predeterminado esfalso .
MailSubject { get; set; } Especifica el texto que aparecerá en la línea de asunto de los correos electrónicos o faxes generados durante la combinación de correspondencia. El valor predeterminado es una cadena vacía.
MainDocumentType { get; set; } Especifica el tipo de documento principal de combinación de correspondencia. El valor predeterminado esDefault .
Odso { get; set; } Obtiene o establece el objeto que especifica la configuración del Objeto de origen de datos de Office (ODSO).
Query { get; set; } Contiene la cadena de lenguaje de consulta estructurado que se ejecutará en la fuente de datos externa especificada para devolver el conjunto de registros que se importarán al documento cuando se realice la operación de combinación de correspondencia. El valor predeterminado es una cadena vacía.
ViewMergedData { get; set; } Especifica que Microsoft Word mostrará los datos de la fuente de datos externa especificada donde se han insertado los campos de combinación (por ejemplo, obtener una vista previa de los datos combinados). El valor predeterminado esfalso .

Métodos

Nombre Descripción
Clear() Borra la configuración de combinación de correspondencia de tal manera que cuando se guarda el documento, no se guardará ninguna configuración de combinación de correspondencia y se convertirá en un documento normal.
Clone() Devuelve un clon profundo de este objeto.

Observaciones

Puede usar este objeto para especificar una fuente de datos de combinación de correspondencia para un documento y esta información (junto con los campos de datos disponibles) aparecerá en Microsoft Word cuando el usuario abra este documento. O puede usar este objeto para consultar la configuración de combinación de correspondencia que el usuario ha especificado en Microsoft Word para este documento.

Normalmente no necesita crear objetos de esta clase directamente porque la configuración de combinación de correo de un documento siempre está disponible a través de laMailMergeSettings propiedad.

Para detectar si este documento es un documento principal de combinación de correspondencia, verifique el valor de MainDocumentType propiedad.

Para eliminar la configuración de combinación de correspondencia y la información de la fuente de datos de un documento, puede usar el Clear método. Aspose.Words no escribirá la configuración de combinación de correspondencia en un documento si elMainDocumentType la propiedad se establece enNotAMergeDocument o elDataType la propiedad se establece enNone.

La mejor manera de aprender a usar las propiedades de este objeto es crear un documento con una fuente de datos deseada manualmente en Microsoft Word y luego abrir ese documento usando Aspose.Words y examinar las propiedades delMailMergeSettings yOdso objetos. Este es un buen enfoque si desea aprender a configurar mediante programación una fuente de datos, por ejemplo.

Aspose.Words conserva la información de combinación de correspondencia al cargar, guardar y convertir documentos entre diferentes formatos, pero no usa esta información cuando realiza su propia combinación de correspondencia usando elMailMerge objeto.

Ejemplos

Muestra cómo ejecutar una combinación de correo con datos de un objeto de origen de datos de Office.

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>");

// Crear una fuente de datos en forma de archivo ASCII, con el "|" personaje
// actuando como el delimitador que separa las columnas. La primera línea contiene los nombres de las tres columnas,
// y cada línea subsiguiente es una fila con sus respectivos valores.
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());

// Al abrir este documento en Microsoft Word, se ejecutará la combinación de correspondencia antes de mostrar el contenido. 
doc.Save(ArtifactsDir + "MailMerge.MailMergeSettings.docx");

Ver también