Click or drag to resize

PdfObjectProperties Properties

The PdfObjectProperties Class exposes the following properties.

Properties

Changes made to these properties will not affect the object represented by a PdfObject Class until the setProperties Method is called with this object as a parameter.

NameDescriptionProperty TypeSupported Objects
absoluteHeight Represents the absolute height of the object in the parent page. Integer All (readonly)
absoluteLeft Represents the absolute left position of the object relative to the PdfWebControl / PdfWebControlLite in the parent page. Integer All (readonly)
absoluteTop Represents the absolute top position of the object relative to the PdfWebControl / PdfWebControlLite in the parent page. Integer All (readonly)
absoluteWidth Represents the absolute width of the object in the parent page. Integer All (readonly)
author Represents the annotation author. If empty, "RAD PDF" is used. String MarkupAnnotations (TextAnnotation, HighlightAnnotation, etc)
border Represents the form field, shape or annotation's border characteristics. This property can only be set if the isLocked Method returns false. PdfBorder Class ButtonField, CheckField, ComboField, ListField, RadioField, TextField, EllipseShape, RectangleShape, CircleAnnotation, SquareAnnotation
changeable Indicates whether the object value can be changed (although flags may override this). Boolean All
checked Indicates whether the form field is checked. Boolean CheckField, RadioField
checkType Represents the type of check mark which this object uses. This property can only be set if the isLocked Method returns false. PdfCheckType Enumeration CheckField, RadioField
color Represents the color of a check or annotation object. This property can only be set if the isLocked Method returns false. String (Representing a color in hexadecimal format, e.g. #000000) CaretAnnotation, CheckShape, HighlightAnnotation, StrikeoutAnnotation, UnderlineAnnotation
comb Indicates whether or not the text form field object is a comb field. (This value corresponds to the "Multiline" flag.) This property can only be set if the isLocked Method returns false. Boolean TextField
contents Represents the annotation contents. String MarkupAnnotations (TextAnnotation, HighlightAnnotation, etc)
creationDate Represents the annotation's creation date. Date MarkupAnnotations (TextAnnotation, HighlightAnnotation, etc)
customData Represents custom data associated with this object. String All
deletable Indicates whether the object can be deleted. Boolean All
duplicatable Indicates whether the object can be duplicated in the GUI. Boolean All
destinationPage Represents the destination page of this link, if the destinationType is Page. This property can only be set if the isLocked Method returns false. Integer PdfLinkAnnotation
destinationType Represents the type of link which this class represents. This property is read-only. To change the destination type, simply assign a new destination page or URL. PdfLinkAnnotationDestinationType Enumeration PdfLinkAnnotation
destinationUrl Represents the destination URL of this link, if the destinationType is Url. This property can only be set if the isLocked Method returns false. String PdfLinkAnnotation
doNotScroll Indicates whether or not the text form field object should not scroll and instead restrict input once full. (This value corresponds to the "DoNotScroll" flag.) This property can only be set if the isLocked Method returns false. Boolean TextField
edit Indicates whether or not the combo (drop-down) form field object should allow custom input. (This value corresponds to the "Edit" flag.) This property can only be set if the isLocked Method returns false. Boolean ComboField
editMode Indicates whether or not the object is in text edit mode. This property is read only. Boolean ComboField, TextField, TextShape, MarkupAnnotation
exportValue Represents the export value of this check or radio form field when checked. This property can only be set if the isLocked Method returns false. String CheckField, RadioField
fillColor Represents the fill color of a form field, shape, or annotation object. This property can only be set if the isLocked Method returns false. String (Representing a color in hexadecimal format, e.g. #000000) ButtonField, CheckField, ComboField, ListField, RadioField, TextField, EllipseShape, RectangleShape, CircleAnnotation, SquareAnnotation
font Represents the text or form field object's font characteristics. The font color is used to represent check marks for CheckField and RadioField objects when checked is true. This property can only be set if the isLocked Method returns false. PdfFont Class ButtonField, CheckField, ComboField, ListField, RadioField, TextField, TextShape
height Represents the object height in pixels on the page. This property can only be set if the isLocked Method returns false. Integer All
hideFocusOutline Indicates whether the object's dotted focus outline is shown when the object is selected. Boolean All
hideHighlight Indicates whether the object's highlight (if the object type supports highlighting) is shown. Boolean All
highlightColor Represents the color which should be used to highlight the object (if highlighting is enabled). This property can be set to null to indicate that RAD PDF's default should be used. String CheckField, ComboField, ListField, RadioField, TextField
isReset Indicates whether this field resets the form when clicked. Boolean ButtonField
isSigned Indicates whether this signature shape has been signed by any method (drawn, image, or text). Boolean SignatureShape
isSubmit Indicates whether this field submits the form when clicked. Boolean ButtonField
label Text label to display centered on a button. String ButtonField
left Represents the object position in pixels on the page from the left edge. This property can only be set if the isLocked Method returns false. Integer All
lineColor Represents the color of a line object. String (Representing a color in hexadecimal format, e.g. #000000) LineShape, ArrowShape, InkShape
lineWidth Represents the width of a line object in pixels. Integer LineShape, ArrowShape, InkShape
lockProportions Indicates whether the object proportions can be changed when resized. Boolean All
maxLength Represents the maximum number of characters allowed in the text form field object. A value of 0 indicates that any number of characters can be entered. This property can only be set if the isLocked Method returns false. Integer TextField
moveable Indicates whether the object can be moved. This property can only be set if the isLocked Method returns false. Boolean All
multiline Indicates whether or not the text form field object can contain multiple lines of text. (This value corresponds to the "Multiline" flag.) This property can only be set if the isLocked Method returns false. Boolean TextField
multiSelect Indicates whether or not the list form field object can have multiple objects selected at the same time. (This value corresponds to the "MultiSelect" flag.) This property can only be set if the isLocked Method returns false. Boolean ListField
name Represents the form field name. This property can only be set if the isLocked Method returns false. String ButtonField, CheckField, ComboField, ListField, RadioField, TextField
noView Indicates whether or not an annotation or form field, or shape object is viewed on screen by RAD PDF. (This value corresponds to the "NoView" flag in the PDF standard for annotation or form field objects.) This property can only be set if the isLocked Method returns false. Boolean ButtonField, CheckField, ComboField, ListField, RadioField, TextField, Annotations
opacity Represents the opacity of this object (in percent, from 0 to 100, inclusive). Integer PdfArrowShape, PdfCheckShape, PdfEllipseShape, PdfImageShape, PdfInkShape, PdfLineShape, PdfRectangleShape, PdfTextShape, PdfWhiteoutShape
open Indicates whether or not the markup annotation's popup is open. Boolean MarkupAnnotations (TextAnnotation, HighlightAnnotation, etc), PopupAnnotation (readonly)
outputToPDF Indicates whether or not an object is output to the PDF saved by RAD PDF. This property can only be set if the isLocked Method returns false. Boolean All
penColor Represents the pen color for a signature object. String (Representing a color in hexadecimal format, e.g. #000000) SignatureShape
penWidth Represents the pen width for a signature object in pixels. Integer SignatureShape
print Indicates whether or not an annotation, form field, or shape object is printed by RAD PDF. (This value corresponds to the "Print" flag in the PDF standard for annotation or form field objects.) This property can only be set if the isLocked Method returns false. Boolean All
readOnly Indicates whether or not the form field object is read only. (This value corresponds to the "ReadOnly" flag in the PDF standard.) This property can only be set if the isLocked Method returns false. Boolean ButtonField, CheckField, ComboField, ListField, RadioField, SignatureField, TextField
resizable Indicates whether the object can be resized. This property can only be set if the isLocked Method returns false. Boolean All
required Indicates whether or not the form field object is a required field. (This value corresponds to the "Required" flag.) This property can only be set if the isLocked Method returns false. Boolean ComboField, RadioField, SignatureField, TextField
rotation Represents the object rotation relative to the page when upright (when the page's orientation / rotation is zero). This value must be a multiple of 90 (e.g. 0, 90, 180, 270). This value does not change if the parent page is rotated. If this is a form field, this property can only be set if the isLocked Method returns false. Boolean ButtonField, CheckField, ComboField, ListField, RadioField, SignatureField, TextField, ImageShape, SignatureShape, TextShape
sort Indicates whether or not the form field object's list of options are sorted. (This value corresponds to the "Sort" flag.) This property can only be set if the isLocked Method returns false. Boolean ComboField, ListField
stylable Indicates whether the object can be styled (e.g. font or color changed). This property can only be set if the isLocked Method returns false. Boolean All
subject Represents the annotation subject. String MarkupAnnotations (TextAnnotation, HighlightAnnotation, etc)
text Represents the object text. String TextShape
tooltip Represents the tooltip text which will be shown when the mouse hovers over this form field object. This property can only be set if the isLocked Method returns false. String ButtonField, CheckField, ComboField, ListField, RadioField, SignatureField, TextField
top Represents the object position in pixels on the page from the top edge. This property can only be set if the isLocked Method returns false. Integer All
value Represents the form field value. The values in a multi-select list field are seperated by the new line character. String ComboField, ListField, TextField
visible Indicates whether the object is visible (although flags may override this). Boolean All
width Represents the object width in pixels on the page. This property can only be set if the isLocked Method returns false. Integer All
See Also