RichTextBoxField class

Class describes rich text editor component.

public sealed class RichTextBoxField : TextBoxField


Name Description
RichTextBoxField(Page, Rectangle) Constructor for Rich Text Box field.


Name Description
Actions { get; } Gets the annotation actions. (2 properties)
virtual ActiveState { get; set; } Gets or sets current annotation appearance state.
AlternateName { get; set; } Gets or sets alternate name of the field (An alternate field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface). Alternate name is used as field tooltip in Adobe Acrobat.
AnnotationIndex { get; set; } Gets or sets index of this anotation on the page.
override AnnotationType { get; } Gets type of annotation.
Appearance { get; } Gets appearance dictionary of the annotation.
Border { get; set; } Gets or sets annotation border characteristics. Border
Characteristics { get; } Gets annotation characteristics.
Color { get; set; } Gets or sets annotation color.
Contents { get; set; } Gets or sets annotation text.
Count { get; } Gets or sets number of subfields in this field. (For example number of items in radio button field).
DefaultAppearance { get; set; } Gets or sets default appearance of the field.
Exportable { get; set; } Gets or sets exportable flag of the field.
Flags { get; set; } Flags of the annotation.
ForceCombs { get; set; } Gets or sets flag which indicates is field divided into spaced positions.
FormattedValue { get; set; } Gets or sets formatted rich text value with markup.
FullName { get; } Gets full qualified name of the annotation.
virtual Height { get; set; } Gets or sets height of the annotation.
Highlighting { get; set; } Annotation highlighting mode.
virtual Hyperlink { get; set; } Gets or sets the fragment hyperlink(for pdf generator).
IsFirstParagraphInColumn { get; set; } Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
IsGroup { get; } Gets or sets boolean value which indicates is this field non-terminal field i.e. group of fields.
IsInLineParagraph { get; set; } Gets or sets a paragraph is inline. Default is false.(for pdf generation)
IsInNewPage { get; set; } Gets or sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
IsKeptWithNext { get; set; } Gets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
IsSharedField { get; set; } Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it’s appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
IsSynchronized { get; } Returns true if dictionary is synchronized.
Item { get; } Gets subfield contained in this field by name of the subfield. (2 indexers)
Justify { get; set; } Gets or sets justification of the rich text box.
MappingName { get; set; } Gets or sets mapping name of the field that shall be used when exporting interactive form field data from the document.
Margin { get; set; } Gets or sets a outer margin for paragraph (for pdf generation)
MaxLen { get; set; } Gets or sets maximum length of text in the field.
Modified { get; set; } Gets or sets date and time when annotation was recently modified.
Multiline { get; set; } Gets or sets multiline flag of the field. If Multiline is true field can contain multiple lines of text.
Name { get; set; } Gets or sets annotation name on the page.
OnActivated { get; set; } An action which shall be performed when the annotation is activated.
override PageIndex { get; } Gets index of page which contains this field.
Parent { get; } Gets annotation parent.
PartialName { get; set; } Gets or sets partial name of the field.
ReadOnly { get; set; } Gets or sets read only status of the field.
override Rect { get; set; } Gets or sets the field rectangle.
Required { get; set; } Gets or sets required status of the field.
RichTextValue { get; set; } Gets or sets rich text value.
Scrollable { get; set; } Gets or sets scrollable flag of field. If true field can be scrolled.
SpellCheck { get; set; } Gets or sets spellcheck flag for field. If true field shall be spell checked.
States { get; } Gets appearance dictionary of annotation.
Style { get; set; } Gets or sets default style string of the rich text field.
SyncRoot { get; } Synchronization object.
TabOrder { get; set; } Gets or sets tab order of the field.
TextHorizontalAlignment { get; set; } Gets or sets text alignment for annotation.
TextVerticalAlignment { get; set; } Gets or sets text vertical alignment for annotation.
override Value { get; set; } Value of RichTextField.
virtual VerticalAlignment { get; set; } Gets or sets a vertical alignment of paragraph
virtual Width { get; set; } Gets or sets width of the annotation.
ZIndex { get; set; } Gets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page.


Name Description
override Accept(AnnotationSelector) Accepts visitor.
AddBarcode(string) Adds barcode 128 into the field. Field value will be changed onto the code and field become read only.
AddImage(Image) Adds image into the field resources an draws it.
virtual ChangeAfterResize(Matrix) Update parameters and appearance, according to the matrix transform.
virtual Clone() Clones this instance. Virtual method. Always return null.
CopyTo(Field[], int) Copies subfields of this field into array starting from specified index.
override Flatten() Removes this field and place its value directly on the page.
GetEnumerator() Returns enumerator of contained fields.
GetRectangle(bool) Returns rectangle of annotation taking into consideration page rotation.
Recalculate() Recaculates all calculated fields on the form.
virtual SetPosition(Point) Set position of the field.

See Also