Class CancelEventArgsExport

class ooodev.events.args.cancel_event_args_export.CancelEventArgsExport(source, event_data, fnm='', overwrite=True, cancel=False)

Bases: EventArgsExport[_T], Generic[_T]

Cancel Event Arguments for Export events.

__init__(source, event_data, fnm='', overwrite=True, cancel=False)

Constructor

Parameters:

• source (Any) – Event Source

• cancel (bool, optional) – Cancel value. Defaults to False.

• event_data (_T) –

• fnm (PathOrStr) –

• overwrite (bool) –

Return type:

None

static from_args(args)

Gets a new instance from existing instance

Parameters:

args (CancelEventArgsExport) – Existing Instance

Returns:

args

Return type:

CancelEventArgsExport

get(key, default=<object object>)

Gets user data from event.

Parameters:

• key (str) – Key used to store data

• default (Any, optional) – Default value to return if key is not found.

Returns:

Data for key if found; Otherwise, if default is set then default.

Return type:

Any

has(key)

Gets if a key exist in the instance

Parameters:

key (str) – key

Returns:

True if key exist; Otherwise False

Return type:

bool

remove(key)

Removes key value pair from instance

Parameters:

key (str) – key

Returns:

True if key was found and removed; Otherwise, False

Return type:

bool

set(key, value, allow_overwrite=True)

Sets a key value pair for event instance.

Parameters:

• key (str) – Key

• value (Any) – Value

• allow_overwrite (bool, optional) – If True and a key already exist then its value will be over written; Otherwise value will not be over written. Defaults to True.

Returns:

True if values is written; Otherwise, False

Return type:

bool

cancel: bool

Gets/Sets cancel value

event_data

property event_name: str

Gets the event name for these args

Return type:

str

property event_source: Any | None

Gets the event source for these args

Return type:

Any | None

fnm: PathOrStr

File name

handled: bool

Get/Set Handled value. Typically if set to True then cancel is ignored.

overwrite: bool

Overwrite file if it exist

source