new WidgetFlags(options)
An object that describes flags on a Widget, or other PDF objects.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
options |
Object |
<nullable> |
Define the set of supported flags. |
Methods
-
get(flag)
-
Determine if the given flag is set.
Parameters:
Name Type Description flagstring The name of the flag to check Returns:
Whether the flag is set- Type
- boolean
-
set(options [, shouldSet])
-
Set flags to true or false. If options is an array of strings, set the flags with those names to true. If options is a number or array of numbers, set the flags from the corresponding numbers to true. (deprecated, relies on a limited interpretation of numbers as bitfields) If options is a string, set that flag to shouldSet.
Parameters:
Name Type Argument Description optionsArray.<string> | Array.<number> | string | number One of the possible input types to determine which flags to set shouldSetboolean <optional>
If options is a string, whether to set or unset the flag