Implements the AUTONUMLGL field.

Examples

Shows how to organize a document using AUTONUMLGL fields.

void FieldAutoNumLgl_()
{
    auto doc = MakeObject<Document>();
    auto builder = MakeObject<DocumentBuilder>(doc);
 
    const String fillerText =
        String(u"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ") +
        u"\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ";
 
    // AUTONUMLGL fields display a number that increments at each AUTONUMLGL field within its current heading level.
    // These fields maintain a separate count for each heading level,
    // and each field also displays the AUTONUMLGL field counts for all heading levels below its own.
    // Changing the count for any heading level resets the counts for all levels above that level to 1.
    // This allows us to organize our document in the form of an outline list.
    // This is the first AUTONUMLGL field at a heading level of 1, displaying "1." in the document.
    InsertNumberedClause(builder, u"\tHeading 1", fillerText, StyleIdentifier::Heading1);
 
    // This is the second AUTONUMLGL field at a heading level of 1, so it will display "2.".
    InsertNumberedClause(builder, u"\tHeading 2", fillerText, StyleIdentifier::Heading1);
 
    // This is the first AUTONUMLGL field at a heading level of 2,
    // and the AUTONUMLGL count for the heading level below it is "2", so it will display "2.1.".
    InsertNumberedClause(builder, u"\tHeading 3", fillerText, StyleIdentifier::Heading2);
 
    // This is the first AUTONUMLGL field at a heading level of 3.
    // Working in the same way as the field above, it will display "2.1.1.".
    InsertNumberedClause(builder, u"\tHeading 4", fillerText, StyleIdentifier::Heading3);
 
    // This field is at a heading level of 2, and its respective AUTONUMLGL count is at 2, so the field will display "2.2.".
    InsertNumberedClause(builder, u"\tHeading 5", fillerText, StyleIdentifier::Heading2);
 
    // Incrementing the AUTONUMLGL count for a heading level below this one
    // has reset the count for this level so that this field will display "2.2.1.".
    InsertNumberedClause(builder, u"\tHeading 6", fillerText, StyleIdentifier::Heading3);
 
    auto isAutoNumLegal = [](SharedPtr<Field> f)
    {
        return f->get_Type() == FieldType::FieldAutoNumLegal;
    };
 
    for (auto field : System::IterateOver<FieldAutoNumLgl>(doc->get_Range()->get_Fields()->LINQ_Where(isAutoNumLegal)))
    {
        // The separator character, which appears in the field result immediately after the number,
        // is a full stop by default. If we leave this property null,
        // our last AUTONUMLGL field will display "2.2.1." in the document.
        ASSERT_TRUE(field->get_SeparatorCharacter() == nullptr);
 
        // Setting a custom separator character and removing the trailing period
        // will change that field's appearance from "2.2.1." to "2:2:1".
        // We will apply this to all the fields that we have created.
        field->set_SeparatorCharacter(u":");
        field->set_RemoveTrailingPeriod(true);
        ASSERT_EQ(u" AUTONUMLGL  \\s : \\e", field->GetFieldCode());
    }
 
    doc->Save(ArtifactsDir + u"Field.AUTONUMLGL.docx");
}
 
static void InsertNumberedClause(SharedPtr<DocumentBuilder> builder, String heading, String contents, StyleIdentifier headingStyle)
{
    builder->InsertField(FieldType::FieldAutoNumLegal, true);
    builder->get_CurrentParagraph()->get_ParagraphFormat()->set_StyleIdentifier(headingStyle);
    builder->Writeln(heading);
 
    // This text will belong to the auto num legal field above it.
    // It will collapse when we click the arrow next to the corresponding AUTONUMLGL field in Microsoft Word.
    builder->get_CurrentParagraph()->get_ParagraphFormat()->set_StyleIdentifier(StyleIdentifier::BodyText);
    builder->Writeln(contents);
}

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

Inheritance diagram for Aspose::Words::Fields::FieldAutoNumLgl:

Public Member Functions
bool	get_RemoveTrailingPeriod ()
	Gets or sets whether to display the number without a trailing period. More...

String	get_SeparatorCharacter ()
	Gets or sets the separator character to be used. More...

FieldSwitchType	GetSwitchType (String switchName) override

virtual const TypeInfo &	GetType () const override

virtual bool	Is (const TypeInfo &target) const override

void	set_RemoveTrailingPeriod (bool value)
	Setter for get_RemoveTrailingPeriod. More...

void	set_SeparatorCharacter (String value)
	Setter for get_SeparatorCharacter. 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_RemoveTrailingPeriod()

bool Aspose::Words::Fields::FieldAutoNumLgl::get_RemoveTrailingPeriod ( )

Gets or sets whether to display the number without a trailing period.

Examples

Shows how to organize a document using AUTONUMLGL fields.

void FieldAutoNumLgl_()
{
    auto doc = MakeObject<Document>();
    auto builder = MakeObject<DocumentBuilder>(doc);
 
    const String fillerText =
        String(u"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ") +
        u"\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ";
 
    // AUTONUMLGL fields display a number that increments at each AUTONUMLGL field within its current heading level.
    // These fields maintain a separate count for each heading level,
    // and each field also displays the AUTONUMLGL field counts for all heading levels below its own.
    // Changing the count for any heading level resets the counts for all levels above that level to 1.
    // This allows us to organize our document in the form of an outline list.
    // This is the first AUTONUMLGL field at a heading level of 1, displaying "1." in the document.
    InsertNumberedClause(builder, u"\tHeading 1", fillerText, StyleIdentifier::Heading1);
 
    // This is the second AUTONUMLGL field at a heading level of 1, so it will display "2.".
    InsertNumberedClause(builder, u"\tHeading 2", fillerText, StyleIdentifier::Heading1);
 
    // This is the first AUTONUMLGL field at a heading level of 2,
    // and the AUTONUMLGL count for the heading level below it is "2", so it will display "2.1.".
    InsertNumberedClause(builder, u"\tHeading 3", fillerText, StyleIdentifier::Heading2);
 
    // This is the first AUTONUMLGL field at a heading level of 3.
    // Working in the same way as the field above, it will display "2.1.1.".
    InsertNumberedClause(builder, u"\tHeading 4", fillerText, StyleIdentifier::Heading3);
 
    // This field is at a heading level of 2, and its respective AUTONUMLGL count is at 2, so the field will display "2.2.".
    InsertNumberedClause(builder, u"\tHeading 5", fillerText, StyleIdentifier::Heading2);
 
    // Incrementing the AUTONUMLGL count for a heading level below this one
    // has reset the count for this level so that this field will display "2.2.1.".
    InsertNumberedClause(builder, u"\tHeading 6", fillerText, StyleIdentifier::Heading3);
 
    auto isAutoNumLegal = [](SharedPtr<Field> f)
    {
        return f->get_Type() == FieldType::FieldAutoNumLegal;
    };
 
    for (auto field : System::IterateOver<FieldAutoNumLgl>(doc->get_Range()->get_Fields()->LINQ_Where(isAutoNumLegal)))
    {
        // The separator character, which appears in the field result immediately after the number,
        // is a full stop by default. If we leave this property null,
        // our last AUTONUMLGL field will display "2.2.1." in the document.
        ASSERT_TRUE(field->get_SeparatorCharacter() == nullptr);
 
        // Setting a custom separator character and removing the trailing period
        // will change that field's appearance from "2.2.1." to "2:2:1".
        // We will apply this to all the fields that we have created.
        field->set_SeparatorCharacter(u":");
        field->set_RemoveTrailingPeriod(true);
        ASSERT_EQ(u" AUTONUMLGL  \\s : \\e", field->GetFieldCode());
    }
 
    doc->Save(ArtifactsDir + u"Field.AUTONUMLGL.docx");
}
 
static void InsertNumberedClause(SharedPtr<DocumentBuilder> builder, String heading, String contents, StyleIdentifier headingStyle)
{
    builder->InsertField(FieldType::FieldAutoNumLegal, true);
    builder->get_CurrentParagraph()->get_ParagraphFormat()->set_StyleIdentifier(headingStyle);
    builder->Writeln(heading);
 
    // This text will belong to the auto num legal field above it.
    // It will collapse when we click the arrow next to the corresponding AUTONUMLGL field in Microsoft Word.
    builder->get_CurrentParagraph()->get_ParagraphFormat()->set_StyleIdentifier(StyleIdentifier::BodyText);
    builder->Writeln(contents);
}

◆ get_SeparatorCharacter()

System::String Aspose::Words::Fields::FieldAutoNumLgl::get_SeparatorCharacter ( )

Gets or sets the separator character to be used.

Examples

Shows how to organize a document using AUTONUMLGL fields.

void FieldAutoNumLgl_()
{
    auto doc = MakeObject<Document>();
    auto builder = MakeObject<DocumentBuilder>(doc);
 
    const String fillerText =
        String(u"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ") +
        u"\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ";
 
    // AUTONUMLGL fields display a number that increments at each AUTONUMLGL field within its current heading level.
    // These fields maintain a separate count for each heading level,
    // and each field also displays the AUTONUMLGL field counts for all heading levels below its own.
    // Changing the count for any heading level resets the counts for all levels above that level to 1.
    // This allows us to organize our document in the form of an outline list.
    // This is the first AUTONUMLGL field at a heading level of 1, displaying "1." in the document.
    InsertNumberedClause(builder, u"\tHeading 1", fillerText, StyleIdentifier::Heading1);
 
    // This is the second AUTONUMLGL field at a heading level of 1, so it will display "2.".
    InsertNumberedClause(builder, u"\tHeading 2", fillerText, StyleIdentifier::Heading1);
 
    // This is the first AUTONUMLGL field at a heading level of 2,
    // and the AUTONUMLGL count for the heading level below it is "2", so it will display "2.1.".
    InsertNumberedClause(builder, u"\tHeading 3", fillerText, StyleIdentifier::Heading2);
 
    // This is the first AUTONUMLGL field at a heading level of 3.
    // Working in the same way as the field above, it will display "2.1.1.".
    InsertNumberedClause(builder, u"\tHeading 4", fillerText, StyleIdentifier::Heading3);
 
    // This field is at a heading level of 2, and its respective AUTONUMLGL count is at 2, so the field will display "2.2.".
    InsertNumberedClause(builder, u"\tHeading 5", fillerText, StyleIdentifier::Heading2);
 
    // Incrementing the AUTONUMLGL count for a heading level below this one
    // has reset the count for this level so that this field will display "2.2.1.".
    InsertNumberedClause(builder, u"\tHeading 6", fillerText, StyleIdentifier::Heading3);
 
    auto isAutoNumLegal = [](SharedPtr<Field> f)
    {
        return f->get_Type() == FieldType::FieldAutoNumLegal;
    };
 
    for (auto field : System::IterateOver<FieldAutoNumLgl>(doc->get_Range()->get_Fields()->LINQ_Where(isAutoNumLegal)))
    {
        // The separator character, which appears in the field result immediately after the number,
        // is a full stop by default. If we leave this property null,
        // our last AUTONUMLGL field will display "2.2.1." in the document.
        ASSERT_TRUE(field->get_SeparatorCharacter() == nullptr);
 
        // Setting a custom separator character and removing the trailing period
        // will change that field's appearance from "2.2.1." to "2:2:1".
        // We will apply this to all the fields that we have created.
        field->set_SeparatorCharacter(u":");
        field->set_RemoveTrailingPeriod(true);
        ASSERT_EQ(u" AUTONUMLGL  \\s : \\e", field->GetFieldCode());
    }
 
    doc->Save(ArtifactsDir + u"Field.AUTONUMLGL.docx");
}
 
static void InsertNumberedClause(SharedPtr<DocumentBuilder> builder, String heading, String contents, StyleIdentifier headingStyle)
{
    builder->InsertField(FieldType::FieldAutoNumLegal, true);
    builder->get_CurrentParagraph()->get_ParagraphFormat()->set_StyleIdentifier(headingStyle);
    builder->Writeln(heading);
 
    // This text will belong to the auto num legal field above it.
    // It will collapse when we click the arrow next to the corresponding AUTONUMLGL field in Microsoft Word.
    builder->get_CurrentParagraph()->get_ParagraphFormat()->set_StyleIdentifier(StyleIdentifier::BodyText);
    builder->Writeln(contents);
}

◆ GetSwitchType()

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

override

◆ GetType()

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

overridevirtual

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

◆ Is()

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

overridevirtual

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

◆ set_RemoveTrailingPeriod()

void Aspose::Words::Fields::FieldAutoNumLgl::set_RemoveTrailingPeriod ( bool value )

Setter for Aspose::Words::Fields::FieldAutoNumLgl::get_RemoveTrailingPeriod.

◆ set_SeparatorCharacter()

void Aspose::Words::Fields::FieldAutoNumLgl::set_SeparatorCharacter ( System::String value )

Setter for Aspose::Words::Fields::FieldAutoNumLgl::get_SeparatorCharacter.

◆ Type()

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

static

Public Member Functions

Static Public Member Functions

Member Function Documentation

◆ get_RemoveTrailingPeriod()

◆ get_SeparatorCharacter()

◆ GetSwitchType()

◆ GetType()

◆ Is()

◆ set_RemoveTrailingPeriod()

◆ set_SeparatorCharacter()

◆ Type()