## FieldStyleRef class Implements the STYLEREF field. To learn more, visit the [Working with Fields](https://docs.aspose.com/words/cpp/working-with-fields/) documentation article. ```cpp class FieldStyleRef : public Aspose::Words::Fields::Field, public IFieldCodeTokenInfoProvider ``` ## Methods | Method | Description | | --- | --- | | [get_DisplayResult](../field/get_displayresult/)() | Gets the text that represents the displayed field result. | | [get_End](../field/get_end/)() const | Gets the node that represents the field end. | | [get_FieldEnd](../field/get_fieldend/)() const | Gets the node that represents the field end. | | [get_FieldStart](../field/get_fieldstart/)() const | Gets the node that represents the start of the field. | | [get_Format](../field/get_format/)() | Gets a [FieldFormat](../fieldformat/) object that provides typed access to field's formatting. | | [get_InsertParagraphNumber](./get_insertparagraphnumber/)() | Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document. | | [get_InsertParagraphNumberInFullContext](./get_insertparagraphnumberinfullcontext/)() | Gets or sets whether to insert the paragraph number of the referenced paragraph in full context. | | [get_InsertParagraphNumberInRelativeContext](./get_insertparagraphnumberinrelativecontext/)() | Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context. | | [get_InsertRelativePosition](./get_insertrelativeposition/)() | Gets or sets whether to insert the relative position of the referenced paragraph. | | [get_IsDirty](../field/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. | | [get_IsLocked](../field/get_islocked/)() | Gets or sets whether the field is locked (should not recalculate its result). | | [get_LocaleId](../field/get_localeid/)() | Gets or sets the LCID of the field. | | [get_Result](../field/get_result/)() | Gets or sets text that is between the field separator and field end. | | [get_SearchFromBottom](./get_searchfrombottom/)() | Gets or sets whether to search from the bottom of the current page, rather from the top. | | [get_Separator](../field/get_separator/)() | Gets the node that represents the field separator. Can be **null**. | | [get_Start](../field/get_start/)() const | Gets the node that represents the start of the field. | | [get_StyleName](./get_stylename/)() | Gets or sets the name of the style by which the text to search for is formatted. | | [get_SuppressNonDelimiters](./get_suppressnondelimiters/)() | Gets or sets whether to suppress non-delimiter characters. | | virtual [get_Type](../field/get_type/)() const | Gets the Microsoft Word field type. | | [GetFieldCode](../field/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](../field/getfieldcode/)(bool) | Returns text between field start and field separator (or field end if there is no separator). | | [GetType](./gettype/)() const override | | | [Is](./is/)(const System::TypeInfo\&) const override | | | virtual [Remove](../field/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_InsertParagraphNumber](./set_insertparagraphnumber/)(bool) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_InsertParagraphNumber](./get_insertparagraphnumber/). | | [set_InsertParagraphNumberInFullContext](./set_insertparagraphnumberinfullcontext/)(bool) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_InsertParagraphNumberInFullContext](./get_insertparagraphnumberinfullcontext/). | | [set_InsertParagraphNumberInRelativeContext](./set_insertparagraphnumberinrelativecontext/)(bool) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_InsertParagraphNumberInRelativeContext](./get_insertparagraphnumberinrelativecontext/). | | [set_InsertRelativePosition](./set_insertrelativeposition/)(bool) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_InsertRelativePosition](./get_insertrelativeposition/). | | [set_IsDirty](../field/set_isdirty/)(bool) | Setter for [Aspose::Words::Fields::Field::get_IsDirty](../field/get_isdirty/). | | [set_IsLocked](../field/set_islocked/)(bool) | Setter for [Aspose::Words::Fields::Field::get_IsLocked](../field/get_islocked/). | | [set_LocaleId](../field/set_localeid/)(int32_t) | Setter for [Aspose::Words::Fields::Field::get_LocaleId](../field/get_localeid/). | | [set_Result](../field/set_result/)(const System::String\&) | Setter for [Aspose::Words::Fields::Field::get_Result](../field/get_result/). | | [set_SearchFromBottom](./set_searchfrombottom/)(bool) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_SearchFromBottom](./get_searchfrombottom/). | | [set_StyleName](./set_stylename/)(const System::String\&) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_StyleName](./get_stylename/). | | [set_SuppressNonDelimiters](./set_suppressnondelimiters/)(bool) | Setter for [Aspose::Words::Fields::FieldStyleRef::get_SuppressNonDelimiters](./get_suppressnondelimiters/). | | static [Type](./type/)() | | | [Unlink](../field/unlink/)() | Performs the field unlink. | | [Update](../field/update/)() | Performs the field update. Throws if the field is being updated already. | | [Update](../field/update/)(bool) | Performs a field update. Throws if the field is being updated already. | ## Examples Shows how to use STYLEREF fields. ```cpp auto doc = System::MakeObject(); auto builder = System::MakeObject(doc); // Create a list based using a Microsoft Word list template. System::SharedPtr list = doc->get_Lists()->Add(Lists::ListTemplate::NumberDefault); // This generated list will display "1.a )". // Space before the bracket is a non-delimiter character, which we can suppress. list->get_ListLevels()->idx_get(0)->set_NumberFormat(u"\x0000" u"."); list->get_ListLevels()->idx_get(1)->set_NumberFormat(u"\x0001" u" )"); // Add text and apply paragraph styles that STYLEREF fields will reference. builder->get_ListFormat()->set_List(list); builder->get_ListFormat()->ListIndent(); builder->get_ParagraphFormat()->set_Style(doc->get_Styles()->idx_get(u"List Paragraph")); builder->Writeln(u"Item 1"); builder->get_ParagraphFormat()->set_Style(doc->get_Styles()->idx_get(u"Quote")); builder->Writeln(u"Item 2"); builder->get_ParagraphFormat()->set_Style(doc->get_Styles()->idx_get(u"List Paragraph")); builder->Writeln(u"Item 3"); builder->get_ListFormat()->RemoveNumbers(); builder->get_ParagraphFormat()->set_Style(doc->get_Styles()->idx_get(u"Normal")); // Place a STYLEREF field in the header and display the first "List Paragraph"-styled text in the document. builder->MoveToHeaderFooter(HeaderFooterType::HeaderPrimary); auto field = System::ExplicitCast(builder->InsertField(FieldType::FieldStyleRef, true)); field->set_StyleName(u"List Paragraph"); // Place a STYLEREF field in the footer, and have it display the last text. builder->MoveToHeaderFooter(HeaderFooterType::FooterPrimary); field = System::ExplicitCast(builder->InsertField(FieldType::FieldStyleRef, true)); field->set_StyleName(u"List Paragraph"); field->set_SearchFromBottom(true); builder->MoveToDocumentEnd(); // We can also use STYLEREF fields to reference the list numbers of lists. builder->Write(u"\nParagraph number: "); field = System::ExplicitCast(builder->InsertField(FieldType::FieldStyleRef, true)); field->set_StyleName(u"Quote"); field->set_InsertParagraphNumber(true); builder->Write(u"\nParagraph number, relative context: "); field = System::ExplicitCast(builder->InsertField(FieldType::FieldStyleRef, true)); field->set_StyleName(u"Quote"); field->set_InsertParagraphNumberInRelativeContext(true); builder->Write(u"\nParagraph number, full context: "); field = System::ExplicitCast(builder->InsertField(FieldType::FieldStyleRef, true)); field->set_StyleName(u"Quote"); field->set_InsertParagraphNumberInFullContext(true); builder->Write(u"\nParagraph number, full context, non-delimiter chars suppressed: "); field = System::ExplicitCast(builder->InsertField(FieldType::FieldStyleRef, true)); field->set_StyleName(u"Quote"); field->set_InsertParagraphNumberInFullContext(true); field->set_SuppressNonDelimiters(true); doc->UpdatePageLayout(); doc->UpdateFields(); doc->Save(get_ArtifactsDir() + u"Field.STYLEREF.docx"); ``` ## See Also * Class [Field](../field/) * Namespace [Aspose::Words::Fields](../) * Library [Aspose.Words for C++](../../)