Aspose::Words::Fields::FieldDatabase class
Contents
[
Hide
]FieldDatabase class
Implements the DATABASE field. To learn more, visit the Working with Fields documentation article.
class FieldDatabase : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
| Method | Description |
|---|---|
| FieldDatabase() | |
| get_Connection() | Gets a connection to the data. |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() const | Gets the node that represents the field end. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| get_FileName() | Gets the complete path and file name of the database. |
| get_FirstRecord() | Gets the integral record number of the first data record to insert. |
| get_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
| get_FormatAttributes() | Gets which attributes of the format are to be applied to the table. |
| get_InsertHeadings() | Gets whether to insert the field names from the database as column headings in the resulting table. |
| get_InsertOnceOnMailMerge() | Gets whether to insert data at the beginning of a merge. |
| get_IsDirty() | Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| get_IsLocked() | Gets or sets whether the field is locked (should not recalculate its result). |
| get_LastRecord() | Gets the integral record number of the last data record to insert. |
| get_LocaleId() | Gets or sets the LCID of the field. |
| get_Query() | Gets a set of SQL instructions that query the database. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_Separator() | Gets the node that represents the field separator. Can be null. |
| get_Start() const | Gets the node that represents the start of the field. |
| get_TableFormat() | Gets the format that is to be applied to the result of the database query. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| 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. |
| GetFieldCode(bool) | Returns text between field start and field separator (or field end if there is no separator). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| 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. |
| set_Connection(const System::String&) | Sets a connection to the data. |
| set_FileName(const System::String&) | Sets the complete path and file name of the database. |
| set_FirstRecord(const System::String&) | Sets the integral record number of the first data record to insert. |
| set_FormatAttributes(const System::String&) | Sets which attributes of the format are to be applied to the table. |
| set_InsertHeadings(bool) | Sets whether to insert the field names from the database as column headings in the resulting table. |
| set_InsertOnceOnMailMerge(bool) | Sets whether to insert data at the beginning of a merge. |
| set_IsDirty(bool) | Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LastRecord(const System::String&) | Sets the integral record number of the last data record to insert. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_Query(const System::String&) | Sets a set of SQL instructions that query the database. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_TableFormat(const System::String&) | Sets the format that is to be applied to the result of the database query. |
| static Type() | |
| Unlink() | Performs the field unlink. |
| Update() | Performs the field update. Throws if the field is being updated already. |
| Update(bool) | Performs a field update. Throws if the field is being updated already. |
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++