Implements the DATABASE field.

#include <Aspose.Words.Cpp/Fields/FieldDatabase.h>

Inheritance diagram for Aspose::Words::Fields::FieldDatabase:

Public Member Functions
String	get_Connection ()
	Gets a connection to the data. More...

String	get_FileName ()
	Gets the complete path and file name of the database. More...

String	get_FirstRecord ()
	Gets the integral record number of the first data record to insert. More...

String	get_FormatAttributes ()
	Gets which attributes of the format are to be applied to the table. More...

bool	get_InsertHeadings ()
	Gets whether to insert the field names from the database as column headings in the resulting table. More...

bool	get_InsertOnceOnMailMerge ()
	Gets whether to insert data at the beginning of a merge. More...

String	get_LastRecord ()
	Gets the integral record number of the last data record to insert. More...

String	get_Query ()
	Gets a set of SQL instructions that query the database. More...

String	get_TableFormat ()
	Gets the format that is to be applied to the result of the database query. More...

FieldSwitchType	GetSwitchType (String switchName) override

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

void	set_Connection (String value)
	Sets a connection to the data. More...

void	set_FileName (String value)
	Sets the complete path and file name of the database. More...

void	set_FirstRecord (String value)
	Sets the integral record number of the first data record to insert. More...

void	set_FormatAttributes (String value)
	Sets which attributes of the format are to be applied to the table. More...

void	set_InsertHeadings (bool value)
	Sets whether to insert the field names from the database as column headings in the resulting table. More...

void	set_InsertOnceOnMailMerge (bool value)
	Sets whether to insert data at the beginning of a merge. More...

void	set_LastRecord (String value)
	Sets the integral record number of the last data record to insert. More...

void	set_Query (String value)
	Sets a set of SQL instructions that query the database. More...

void	set_TableFormat (String value)
	Sets the format that is to be applied to the result of the database query. More...

Public Member Functions inherited from Field
String	get_DisplayResult ()
	Gets the text that represents the displayed field result. More...

SharedPtr< FieldEnd >	get_End () const
	Gets the node that represents the field end. More...

SharedPtr< FieldEnd >	get_FieldEnd () const
	Gets the node that represents the field end. More...

SharedPtr< FieldStart >	get_FieldStart () const
	Gets the node that represents the start of the field. More...

SharedPtr< FieldFormat >	get_Format ()
	Gets a FieldFormat object that provides typed access to field's formatting. More...

bool	get_IsDirty ()
	Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. More...

bool	get_IsLocked ()
	Gets or sets whether the field is locked (should not recalculate its result). More...

int32_t	get_LocaleId ()
	Gets or sets the LCID of the field. More...

String	get_Result ()
	Gets or sets text that is between the field separator and field end. More...

SharedPtr< FieldSeparator >	get_Separator ()
	Gets the node that represents the field separator. Can be null. More...

SharedPtr< FieldStart >	get_Start () const
	Gets the node that represents the start of the field. More...

virtual FieldType	get_Type ()
	Gets the Microsoft Word field type. More...

String	GetFieldCode ()
	Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. More...

String	GetFieldCode (bool includeChildFieldCodes)
	Returns text between field start and field separator (or field end if there is no separator). More...

SharedPtr< Node >	Remove ()
	Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null. More...

void	set_IsDirty (bool value)
	Setter for get_IsDirty. More...

void	set_IsLocked (bool value)
	Setter for get_IsLocked. More...

void	set_LocaleId (int32_t value)
	Setter for get_LocaleId. More...

void	set_Result (String value)
	Setter for get_Result. More...

bool	Unlink ()
	Performs the field unlink. More...

void	Update ()
	Performs the field update. Throws if the field is being updated already. More...

void	Update (bool ignoreMergeFormat)
	Performs a field update. Throws if the field is being updated already. More...

Static Public Member Functions
static const TypeInfo &	Type ()

Static Public Member Functions inherited from Field
static const TypeInfo &	Type ()

Member Function Documentation

◆ get_Connection()

System::String Aspose::Words::Fields::FieldDatabase::get_Connection ( )

Gets a connection to the data.

◆ get_FileName()

System::String Aspose::Words::Fields::FieldDatabase::get_FileName ( )

Gets the complete path and file name of the database.

◆ get_FirstRecord()

System::String Aspose::Words::Fields::FieldDatabase::get_FirstRecord ( )

Gets the integral record number of the first data record to insert.

◆ get_FormatAttributes()

System::String Aspose::Words::Fields::FieldDatabase::get_FormatAttributes ( )

Gets which attributes of the format are to be applied to the table.

◆ get_InsertHeadings()

bool Aspose::Words::Fields::FieldDatabase::get_InsertHeadings ( )

Gets whether to insert the field names from the database as column headings in the resulting table.

◆ get_InsertOnceOnMailMerge()

bool Aspose::Words::Fields::FieldDatabase::get_InsertOnceOnMailMerge ( )

Gets whether to insert data at the beginning of a merge.

◆ get_LastRecord()

System::String Aspose::Words::Fields::FieldDatabase::get_LastRecord ( )

Gets the integral record number of the last data record to insert.

◆ get_Query()

System::String Aspose::Words::Fields::FieldDatabase::get_Query ( )

Gets a set of SQL instructions that query the database.

◆ get_TableFormat()

System::String Aspose::Words::Fields::FieldDatabase::get_TableFormat ( )

Gets the format that is to be applied to the result of the database query.

◆ GetSwitchType()

Aspose::Words::Fields::FieldSwitchType Aspose::Words::Fields::FieldDatabase::GetSwitchType ( System::String switchName )

override

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Fields::FieldDatabase::GetType ( ) const

overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ Is()

virtual bool Aspose::Words::Fields::FieldDatabase::Is ( const System::TypeInfo & target ) const

overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ set_Connection()

void Aspose::Words::Fields::FieldDatabase::set_Connection ( System::String value )

Sets a connection to the data.

◆ set_FileName()

void Aspose::Words::Fields::FieldDatabase::set_FileName ( System::String value )

Sets the complete path and file name of the database.

◆ set_FirstRecord()

void Aspose::Words::Fields::FieldDatabase::set_FirstRecord ( System::String value )

Sets the integral record number of the first data record to insert.

◆ set_FormatAttributes()

void Aspose::Words::Fields::FieldDatabase::set_FormatAttributes ( System::String value )

Sets which attributes of the format are to be applied to the table.

◆ set_InsertHeadings()

void Aspose::Words::Fields::FieldDatabase::set_InsertHeadings ( bool value )

Sets whether to insert the field names from the database as column headings in the resulting table.

◆ set_InsertOnceOnMailMerge()

void Aspose::Words::Fields::FieldDatabase::set_InsertOnceOnMailMerge ( bool value )

Sets whether to insert data at the beginning of a merge.

◆ set_LastRecord()

void Aspose::Words::Fields::FieldDatabase::set_LastRecord ( System::String value )

Sets the integral record number of the last data record to insert.

◆ set_Query()

void Aspose::Words::Fields::FieldDatabase::set_Query ( System::String value )

Sets a set of SQL instructions that query the database.

◆ set_TableFormat()

void Aspose::Words::Fields::FieldDatabase::set_TableFormat ( System::String value )

Sets the format that is to be applied to the result of the database query.

◆ Type()

static const System::TypeInfo& Aspose::Words::Fields::FieldDatabase::Type ( )

static

Public Member Functions

Static Public Member Functions