search/mag_sel search/close
FieldChar.h
1 // Copyright 2001-2021 Aspose Pty Ltd. All Rights Reserved.
3 //
4 // This file is part of Aspose.Words. The source code in this file
5 // is only intended as a supplement to the documentation, and is provided
6 // "as is", without warranty of any kind, either expressed or implied.
9 #pragma once
10 
11 #include <system/shared_ptr.h>
12 
13 #include <Aspose.Words.Cpp/SpecialChar.h>
14 #include <Aspose.Words.Cpp/Fields/FieldType.h>
15 #include <Aspose.Words.Cpp/aspose_words_api_defs.h>
16 
17 namespace Aspose { namespace Words { namespace Layout { namespace PreAps { class PageLayout; } } } }
18 namespace Aspose { namespace Words { class PageExtractor; } }
19 namespace Aspose { namespace Words { class FieldRemoverRetainCertainFieldsFilter; } }
20 namespace Aspose { namespace Words { class FieldRemoverRetainFwrFieldsFilter; } }
21 namespace Aspose { namespace Words { namespace Validation { class EQFieldConverter; } } }
22 namespace Aspose { namespace Words { namespace Fields { class FieldExtractor; } } }
23 namespace Aspose { namespace Words { namespace RW { namespace Docx { namespace Writer { class DocxFieldsWriter; } } } } }
24 namespace Aspose { namespace Words { namespace RW { namespace Nrx { namespace Writer { class NrxFieldsWriter; } } } } }
25 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Reader { class HtmlParagraphArranger; } } } } }
26 namespace Aspose { namespace Words { namespace RW { namespace Markdown { namespace Writer { class MarkdownHyperlinkWriter; } } } } }
27 namespace Aspose { namespace Words { namespace RW { namespace Wml { namespace Writer { class WmlFieldsWriter; } } } } }
28 namespace Aspose { namespace Words { namespace RW { namespace Nrx { namespace Reader { class NrxFldCharReaderBase; } } } } }
29 namespace Aspose { namespace Words { namespace Fonts { class EmbeddedFontCollector; } } }
30 namespace Aspose { namespace Words { namespace Fields { class Field; } } }
31 namespace Aspose { namespace Words { namespace Fields { class FieldUnknown; } } }
32 namespace Aspose { namespace Words { namespace Fields { class FakeResultHelper; } } }
33 namespace Aspose { namespace Words { namespace Fields { class FieldFakeResultAppender; } } }
34 namespace Aspose { namespace Words { namespace Fields { class FieldEQ; } } }
35 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlImageWriter; } } } } }
36 namespace Aspose { namespace Words { namespace RW { namespace Odt { namespace Writer { class OdtTrackedChangesWriter; } } } } }
37 namespace Aspose { namespace Words { namespace Fields { class FieldFactory; } } }
38 namespace Aspose { namespace Words { namespace Fields { class MergeFieldFinder; } } }
39 namespace Aspose { namespace Words { namespace Fields { class ParagraphTocEntry; } } }
40 namespace Aspose { namespace Words { namespace Fields { class TocEntryExtractor; } } }
41 namespace Aspose { namespace Words { namespace Fields { class FieldUtil; } } }
42 namespace Aspose { namespace Words { class ShapeFieldRemover; } }
43 namespace Aspose { namespace Words { class NodeTextCollector; } }
44 namespace Aspose { namespace Words { namespace Layout { namespace Core { class SpanField; } } } }
45 namespace Aspose { namespace Words { namespace Layout { class DocumentSpanConverter; } } }
46 namespace Aspose { namespace Words { namespace Fields { class NodeRangeFieldCodeTokenizer; } } }
47 namespace Aspose { namespace Words { namespace Fields { class FieldBundle; } } }
48 namespace Aspose { namespace Words { namespace Fields { class FieldEnd; } } }
49 namespace Aspose { namespace Words { namespace Fields { class FieldSeparator; } } }
50 namespace Aspose { namespace Words { namespace Fields { class FieldStart; } } }
51 namespace Aspose { namespace Words { namespace Tables { class TableFormattingExpander; } } }
52 namespace Aspose { namespace Words { namespace Validation { class DocumentPostLoader; } } }
53 namespace Aspose { namespace Words { namespace Validation { class DocumentValidator; } } }
54 namespace Aspose { namespace Words { namespace Validation { class FieldValidator; } } }
55 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlFieldWriter; } } } } }
56 namespace Aspose { namespace Words { namespace RW { namespace MarkupLanguage { namespace Writer { class MarkupLanguageFieldWriterBase; } } } } }
57 namespace Aspose { namespace Words { namespace Fields { class FieldRefUtil; } } }
58 namespace Aspose { namespace Words { namespace Fields { class FieldNumListLabelUpdater; } } }
59 namespace Aspose { namespace Words { namespace RW { namespace Odt { namespace Writer { class OdtFieldWriter; } } } } }
60 namespace Aspose { namespace Words { namespace RW { namespace Doc { namespace Reader { class ModelBuilder; } } } } }
61 namespace Aspose { namespace Words { namespace RW { namespace Doc { namespace Writer { class DocWriter; } } } } }
62 namespace Aspose { namespace Words { namespace RW { namespace Odt { class OdtUtil; } } } }
63 namespace Aspose { namespace Words { namespace RW { namespace Rtf { namespace Writer { class RtfWriter; } } } } }
64 namespace Aspose { namespace Words { namespace RW { namespace Txt { namespace Writer { class TxtWriter; } } } } }
65 namespace Aspose { namespace Words { class DocumentBase; } }
66 namespace Aspose { namespace Words { class RunPr; } }
67 
68 namespace Aspose {
69 
70 namespace Words {
71 
72 namespace Fields {
73 
113 class ASPOSE_WORDS_SHARED_CLASS FieldChar : public Aspose::Words::SpecialChar
114 {
115  typedef FieldChar ThisType;
116  typedef Aspose::Words::SpecialChar BaseType;
117 
118  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
119  ASPOSE_WORDS_SHARED_RTTI_INFO_DECL();
120 
121  friend class Aspose::Words::Layout::PreAps::PageLayout;
122  friend class Aspose::Words::PageExtractor;
123  friend class Aspose::Words::FieldRemoverRetainCertainFieldsFilter;
124  friend class Aspose::Words::FieldRemoverRetainFwrFieldsFilter;
125  friend class Aspose::Words::Validation::EQFieldConverter;
126  friend class Aspose::Words::Fields::FieldExtractor;
127  friend class Aspose::Words::RW::Docx::Writer::DocxFieldsWriter;
128  friend class Aspose::Words::RW::Nrx::Writer::NrxFieldsWriter;
129  friend class Aspose::Words::RW::Html::Reader::HtmlParagraphArranger;
130  friend class Aspose::Words::RW::Markdown::Writer::MarkdownHyperlinkWriter;
131  friend class Aspose::Words::RW::Wml::Writer::WmlFieldsWriter;
132  friend class Aspose::Words::RW::Nrx::Reader::NrxFldCharReaderBase;
133  friend class Aspose::Words::Fonts::EmbeddedFontCollector;
134  friend class Aspose::Words::Fields::Field;
135  friend class Aspose::Words::Fields::FieldUnknown;
136  friend class Aspose::Words::Fields::FakeResultHelper;
137  friend class Aspose::Words::Fields::FieldFakeResultAppender;
138  friend class Aspose::Words::Fields::FieldEQ;
139  friend class Aspose::Words::RW::Html::Writer::HtmlImageWriter;
140  friend class Aspose::Words::RW::Odt::Writer::OdtTrackedChangesWriter;
141  friend class Aspose::Words::Fields::FieldFactory;
142  friend class Aspose::Words::Fields::MergeFieldFinder;
143  friend class Aspose::Words::Fields::ParagraphTocEntry;
144  friend class Aspose::Words::Fields::TocEntryExtractor;
145  friend class Aspose::Words::Fields::FieldUtil;
146  friend class Aspose::Words::ShapeFieldRemover;
147  friend class Aspose::Words::NodeTextCollector;
148  friend class Aspose::Words::Layout::Core::SpanField;
149  friend class Aspose::Words::Layout::DocumentSpanConverter;
150  friend class Aspose::Words::Fields::NodeRangeFieldCodeTokenizer;
151  friend class Aspose::Words::Fields::FieldBundle;
152  friend class Aspose::Words::Fields::FieldEnd;
153  friend class Aspose::Words::Fields::FieldSeparator;
154  friend class Aspose::Words::Fields::FieldStart;
155  friend class Aspose::Words::Tables::TableFormattingExpander;
156  friend class Aspose::Words::Validation::DocumentPostLoader;
157  friend class Aspose::Words::Validation::DocumentValidator;
158  friend class Aspose::Words::Validation::FieldValidator;
159  friend class Aspose::Words::RW::Html::Writer::HtmlFieldWriter;
160  friend class Aspose::Words::RW::MarkupLanguage::Writer::MarkupLanguageFieldWriterBase;
161  friend class Aspose::Words::Fields::FieldRefUtil;
162  friend class Aspose::Words::Fields::FieldRefUtil;
163  friend class Aspose::Words::Fields::FieldNumListLabelUpdater;
164  friend class Aspose::Words::RW::Odt::Writer::OdtFieldWriter;
165  friend class Aspose::Words::RW::Doc::Reader::ModelBuilder;
166  friend class Aspose::Words::RW::Doc::Writer::DocWriter;
167  friend class Aspose::Words::RW::Odt::OdtUtil;
168  friend class Aspose::Words::RW::Rtf::Writer::RtfWriter;
169  friend class Aspose::Words::RW::Txt::Writer::TxtWriter;
170 
171 public:
172 
201  ASPOSE_WORDS_SHARED_API Aspose::Words::Fields::FieldType get_FieldType() const;
202 
231  ASPOSE_WORDS_SHARED_API bool get_IsLocked() const;
232 
234  ASPOSE_WORDS_SHARED_API void set_IsLocked(bool value);
235 
265  ASPOSE_WORDS_SHARED_API bool get_IsDirty() const;
266 
268  ASPOSE_WORDS_SHARED_API void set_IsDirty(bool value);
269 
300  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Fields::Field> GetField();
301 
302 protected:
303 
304  ASPOSE_WORDS_SHARED_API void set_FieldType(Aspose::Words::Fields::FieldType value);
305  bool get_IsPrivate() const;
306  void set_IsPrivate(bool value);
307 
308  FieldChar(System::SharedPtr<Aspose::Words::DocumentBase> doc, char16_t fieldChar, System::SharedPtr<Aspose::Words::RunPr> runPr, Aspose::Words::Fields::FieldType type);
309 
310  virtual ASPOSE_WORDS_SHARED_API ~FieldChar();
311 
312 private:
313 
314  Aspose::Words::Fields::FieldType pr_FieldType;
315  bool pr_IsLocked;
316  bool pr_IsDirty;
317  bool pr_IsPrivate;
318 
319 };
320 
321 }
322 }
323 }