Aspose::Words::Fields::FieldAdvance class
Contents
[
Hide
]FieldAdvance class
Implements the ADVANCE field. To learn more, visit the Working with Fields documentation article.
class FieldAdvance : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
| Method | Description |
|---|---|
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_DownOffset() | Gets or sets the number of points by which the text that follows the field should be moved down. |
| 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_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
| get_HorizontalPosition() | Gets or sets the number of points by which the text that follows the field should be moved horizontally from the left edge of the column, frame, or text box. |
| 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_LeftOffset() | Gets or sets the number of points by which the text that follows the field should be moved left. |
| get_LocaleId() | Gets or sets the LCID of the field. |
| get_Result() | Gets or sets text that is between the field separator and field end. |
| get_RightOffset() | Gets or sets the number of points by which the text that follows the field should be moved right. |
| 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. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| get_UpOffset() | Gets or sets the number of points by which the text that follows the field should be moved up. |
| get_VerticalPosition() | Gets or sets the number of points by which the text that follows the field should be moved vertically from the top edge of the page. |
| 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_DownOffset(const System::String&) | Setter for Aspose::Words::Fields::FieldAdvance::get_DownOffset. |
| set_HorizontalPosition(const System::String&) | Setter for Aspose::Words::Fields::FieldAdvance::get_HorizontalPosition. |
| 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_LeftOffset(const System::String&) | Setter for Aspose::Words::Fields::FieldAdvance::get_LeftOffset. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_RightOffset(const System::String&) | Setter for Aspose::Words::Fields::FieldAdvance::get_RightOffset. |
| set_UpOffset(const System::String&) | Setter for Aspose::Words::Fields::FieldAdvance::get_UpOffset. |
| set_VerticalPosition(const System::String&) | Setter for Aspose::Words::Fields::FieldAdvance::get_VerticalPosition. |
| 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. |
Examples
Shows how to insert an ADVANCE field, and edit its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Write(u"This text is in its normal place.");
// Below are two ways of using the ADVANCE field to adjust the position of text that follows it.
// The effects of an ADVANCE field continue to be applied until the paragraph ends,
// or another ADVANCE field updates the offset/coordinate values.
// 1 - Specify a directional offset:
auto field = System::ExplicitCast<FieldAdvance>(builder->InsertField(FieldType::FieldAdvance, true));
field->set_RightOffset(u"5");
field->set_UpOffset(u"5");
ASSERT_EQ(u" ADVANCE \\r 5 \\u 5", field->GetFieldCode());
builder->Write(u"This text will be moved up and to the right.");
field = System::ExplicitCast<FieldAdvance>(builder->InsertField(FieldType::FieldAdvance, true));
field->set_DownOffset(u"5");
field->set_LeftOffset(u"100");
ASSERT_EQ(u" ADVANCE \\d 5 \\l 100", field->GetFieldCode());
builder->Writeln(u"This text is moved down and to the left, overlapping the previous text.");
// 2 - Move text to a position specified by coordinates:
field = System::ExplicitCast<FieldAdvance>(builder->InsertField(FieldType::FieldAdvance, true));
field->set_HorizontalPosition(u"-100");
field->set_VerticalPosition(u"200");
ASSERT_EQ(u" ADVANCE \\x -100 \\y 200", field->GetFieldCode());
builder->Write(u"This text is in a custom position.");
doc->Save(ArtifactsDir + u"Field.ADVANCE.docx");
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++