Public Member Functions | |
Control (const Control &other) | |
Constructor, with another form control object. More... | |
~Control () | |
Destructor. | |
WString | GetExportValue () const |
Get export mapping name when related form field is check box or radio button. More... | |
Field | GetField () const |
Get the related form field. More... | |
int | GetIndex () const |
Get the index of current form control among all the controls of related form field. More... | |
annots::Widget | GetWidget () const |
Get the related widget annotation. More... | |
bool | IsChecked () const |
Check if the current form control is checked when related form field is check box or radio button. More... | |
bool | IsDefaultChecked () const |
Check if the current form control is checked by default when related form field is check box or radio button. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const Control &other) const |
Not equal operator. More... | |
Control & | operator= (const Control &other) |
Assign operator. More... | |
bool | operator== (const Control &other) const |
Equal operator. More... | |
void | SetChecked (bool checked_status) |
Set the check state of current form control when related form field is check box or radio button. More... | |
void | SetDefaultChecked (bool checked_status) |
Set the default check state of current form control when related form field is check box or radio button. More... | |
void | SetExportValue (const wchar_t *value) |
Set export mapping name when related form field is check box or radio button. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
Foxit PDF SDK defines "form control" to associate form field with its related widget annotations. A form field may have one or more form controls, and each form control is associated with a widget annotation. A form control object can be retrieved by following functions:
Form control also offers functions to get related form field object and widget annotation object.
Function Form::AddControl can be used to add a new form control to a form field, and function Form::RemoveControl can be used to remove a form control.
foxit::pdf::interform::Control::Control | ( | const Control & | other | ) |
Constructor, with another form control object.
[in] | other | Another form control object. |
WString foxit::pdf::interform::Control::GetExportValue | ( | ) | const |
Get export mapping name when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return an empty string.
Field foxit::pdf::interform::Control::GetField | ( | ) | const |
Get the related form field.
int foxit::pdf::interform::Control::GetIndex | ( | ) | const |
Get the index of current form control among all the controls of related form field.
annots::Widget foxit::pdf::interform::Control::GetWidget | ( | ) | const |
Get the related widget annotation.
bool foxit::pdf::interform::Control::IsChecked | ( | ) | const |
Check if the current form control is checked when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return false.
bool foxit::pdf::interform::Control::IsDefaultChecked | ( | ) | const |
Check if the current form control is checked by default when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return false.
bool foxit::pdf::interform::Control::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::pdf::interform::Control::operator!= | ( | const Control & | other | ) | const |
Not equal operator.
[in] | other | Another form control object. This function will check if current object is not equal to this one. |
Assign operator.
[in] | other | Another form control object, whose value would be assigned to current object. |
bool foxit::pdf::interform::Control::operator== | ( | const Control & | other | ) | const |
Equal operator.
[in] | other | Another form control object. This function will check if current object is equal to this one. |
void foxit::pdf::interform::Control::SetChecked | ( | bool | checked_status | ) |
Set the check state of current form control when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | checked_status | true means checked, and false means not checked. |
void foxit::pdf::interform::Control::SetDefaultChecked | ( | bool | checked_status | ) |
Set the default check state of current form control when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | checked_status | true means checked by default, and false means not checked by default. |
void foxit::pdf::interform::Control::SetExportValue | ( | const wchar_t * | value | ) |
Set export mapping name when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | value | The new export mapping name. It should not be an empty string. |