Represents information about a single record within an external data source that is to be excluded from the mail merge.

If a record shall be merged into a merged document, then no information is needed about that record. However, if a given record shall not be merged into a merged document, then the value of the unique key for that record shall be stored in the UniqueTag property of this object to indicate this exclusion.

#include <Aspose.Words.Cpp/Settings/OdsoRecipientData.h>

Inheritance diagram for Aspose::Words::Settings::OdsoRecipientData:

Public Member Functions
	OdsoRecipientData ()

SharedPtr< OdsoRecipientData >	Clone ()
	Returns a deep clone of this object. More...

bool	get_Active () const
	Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. The default value is `true`. More...

int32_t	get_Column () const
	Specifies the column within the data source that contains unique data for the current record. The default value is 0. More...

int32_t	get_Hash () const
	Represents the hash code for this record. Sometimes Microsoft Word uses Hash of a whole record instead of a UniqueTag value. The default value is 0. More...

ArrayPtr< uint8_t >	get_UniqueTag () const
	Specifies the contents of a given record in the column containing unique data. The default value is `null`. More...

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

void	set_Active (bool value)
	Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. The default value is `true`. More...

void	set_Column (int32_t value)
	Specifies the column within the data source that contains unique data for the current record. The default value is 0. More...

void	set_Hash (int32_t value)
	Represents the hash code for this record. Sometimes Microsoft Word uses Hash of a whole record instead of a UniqueTag value. The default value is 0. More...

void	set_UniqueTag (ArrayPtr< uint8_t > value)
	Specifies the contents of a given record in the column containing unique data. The default value is `null`. More...

Static Public Member Functions
static const TypeInfo &	Type ()

Constructor & Destructor Documentation

◆ OdsoRecipientData()

Aspose::Words::Settings::OdsoRecipientData::OdsoRecipientData ( )

Member Function Documentation

◆ Clone()

System::SharedPtr<Aspose::Words::Settings::OdsoRecipientData> Aspose::Words::Settings::OdsoRecipientData::Clone ( )

Returns a deep clone of this object.

◆ get_Active()

bool Aspose::Words::Settings::OdsoRecipientData::get_Active ( ) const

Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. The default value is true.

◆ get_Column()

int32_t Aspose::Words::Settings::OdsoRecipientData::get_Column ( ) const

Specifies the column within the data source that contains unique data for the current record. The default value is 0.

◆ get_Hash()

int32_t Aspose::Words::Settings::OdsoRecipientData::get_Hash ( ) const

Represents the hash code for this record. Sometimes Microsoft Word uses Hash of a whole record instead of a UniqueTag value. The default value is 0.

◆ get_UniqueTag()

System::ArrayPtr<uint8_t> Aspose::Words::Settings::OdsoRecipientData::get_UniqueTag ( ) const

Specifies the contents of a given record in the column containing unique data. The default value is null.

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Settings::OdsoRecipientData::GetType ( ) const

overridevirtual

Reimplemented from System::Object.

◆ Is()

virtual bool Aspose::Words::Settings::OdsoRecipientData::Is ( const System::TypeInfo & target ) const

overridevirtual

Reimplemented from System::Object.

◆ set_Active()

void Aspose::Words::Settings::OdsoRecipientData::set_Active ( bool value )

Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. The default value is true.

◆ set_Column()

void Aspose::Words::Settings::OdsoRecipientData::set_Column ( int32_t value )

Specifies the column within the data source that contains unique data for the current record. The default value is 0.

◆ set_Hash()

void Aspose::Words::Settings::OdsoRecipientData::set_Hash ( int32_t value )