ButtonWidgetAnnotation Class

Defines a widget annotation associated with the button field in a PDF document.

Declaration

public class ButtonWidgetAnnotation extends WidgetAnnotation

Remarks

Refer to the following help topic for additional information: Create PDF Forms.

Inherited Members

clone(DocumentCloneContext context)

setAppearance(AnnotationAppearances value)

setAppearanceName(String value)

setBorder(AnnotationBorder value)

setBounds(RectangleF value)

setColor(PdfColor value)

setContent(String value)

setHidden(boolean value)

setInvisible(boolean value)

setLocked(boolean value)

setLockedContents(boolean value)

setModified(OffsetDateTime value)

setName(String value)

setNoRotate(boolean value)

setNoView(boolean value)

setNoZoom(boolean value)

setPrint(boolean value)

setReadOnly(boolean value)

setToggleNoView(boolean value)

setAction(InteractiveAction value)

setActions(WidgetAnnotationActions value)

setBackgroundColor(PdfColor value)

setBorderStyle(AnnotationBorderStyle value)

setFont(TextFont value)

setFontSize(double value)

setForeColor(PdfColor value)

setOutlineColor(PdfColor value)

setRotationAngle(double value)

setTextAlignment(FormFieldTextAlignment value)

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

JavaObject

BaseAnnotation

WidgetAnnotation

ButtonWidgetAnnotation

ButtonWidgetAnnotation(FormField formField, RectangleF bounds)

Initializes a new instance of the ButtonWidgetAnnotation class with specified form field and bounds.

Declaration

public ButtonWidgetAnnotation(FormField formField, RectangleF bounds)

Parameters

Name	Type	Description
formField	FormField	The form field associated with the button widget annotation.
bounds	RectangleF	The annotation bounds.

Methods

getAlternateCaption() Method

Returns the alternate caption displayed when the button widget annotation is pressed.

Declaration

public String getAlternateCaption()

Returns

Type	Description
String	The alternate caption.

getAlternateIcon() Method

Returns the alternate icon displayed when the button widget annotation is pressed.

Declaration

public DXImage getAlternateIcon()

Returns

Type	Description
DXImage	The alternate icon.

getCaption() Method

Returns the button widget annotation caption.

Declaration

public String getCaption()

Returns

Type	Description
String	The caption.

getCaptionLayout() Method

Returns the button widget annotation caption layout.

Declaration

public ButtonCaptionLayout getCaptionLayout()

Returns

Type	Description
ButtonCaptionLayout	The caption layout.

getIconFit() Method

Returns the button widget annotation icon fit settings.

Declaration

public ButtonIconFit getIconFit()

Returns

Type	Description
ButtonIconFit	The icon fit settings.

getNormalIcon() Method

Returns the normal icon displayed by the button widget annotation.

Declaration

public DXImage getNormalIcon()

Returns

Type	Description
DXImage	The normal icon.

getRolloverCaption() Method

Returns the rollover caption displayed when the pointer hovers over the button widget annotation.

Declaration

public String getRolloverCaption()

Returns

Type	Description
String	The rollover caption.

getRolloverIcon() Method

Returns the rollover icon displayed when the pointer hovers over the button widget annotation.

Declaration

public DXImage getRolloverIcon()

Returns

Type	Description
DXImage	The rollover icon.

setAlternateCaption(String value) Method

Sets the alternate caption displayed when the button widget annotation is pressed.

Declaration

public void setAlternateCaption(String value)

Parameters

Name	Type	Description
value	String	The alternate caption.

setAlternateIcon(DXImage value) Method

Sets the alternate icon displayed when the button widget annotation is pressed.

Declaration

public void setAlternateIcon(DXImage value)

Parameters

Name	Type	Description
value	DXImage	The alternate icon.

setCaption(String value) Method

Sets the button widget annotation caption.

Declaration

public void setCaption(String value)

Parameters

Name	Type	Description
value	String	The caption.

setCaptionLayout(ButtonCaptionLayout value) Method

Sets the button widget annotation caption layout.

Declaration

public void setCaptionLayout(ButtonCaptionLayout value)

Parameters

Name	Type	Description
value	ButtonCaptionLayout	The caption layout.

setIconFit(ButtonIconFit value) Method

Sets the button widget annotation icon fit settings.

Declaration

public void setIconFit(ButtonIconFit value)

Parameters

Name	Type	Description
value	ButtonIconFit	The icon fit settings.

setNormalIcon(DXImage value) Method

Sets the normal icon displayed by the button widget annotation.

Declaration

public void setNormalIcon(DXImage value)

Parameters

Name	Type	Description
value	DXImage	The normal icon.

setRolloverCaption(String value) Method

Sets the rollover caption displayed when the pointer hovers over the button widget annotation.

Declaration

public void setRolloverCaption(String value)

Parameters

Name	Type	Description
value	String	The rollover caption.

setRolloverIcon(DXImage value) Method

Sets the rollover icon displayed when the pointer hovers over the button widget annotation.

Declaration

public void setRolloverIcon(DXImage value)

Parameters

Name	Type	Description
value	DXImage	The rollover icon.