All View Calls¶

A helpful reference for all supported calls for view scripts.

This script shows all the entry points that you can use when writing a script for a view. It doesn’t actually do anything useful.

Updated 2019 2665093 Ontario Inc.

poplar_oeaddlne.resources.all_view_calls.onAfterAttributes(e)[source]¶

Called after the attributes of a view field are changed.

Parameters:	result (int) – result of the attribute operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterCancel(result)[source]¶

Called after a view is canceled.

Parameters:	result (int) – result of the cancel operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterClose(result)[source]¶

Called after a view is closed.

Parameters:	result (int) – result of the close operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterCompose(event)[source]¶

Called after a view is composed.

Parameters:	event (`accpac.viewComposeArgs`) – compose event information.
Returns:	must return `accpac.Continue` or the view will not load.
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onAfterDelete(result)[source]¶

Called after a view is deleted.

Parameters:	result (int) – result of the delete operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterDirty(result)[source]¶

Called after a view is marked dirty.

Parameters:	result (int) – result of the mark dirty operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterFetchLock(result)[source]¶

Called after a view releases a lock for a fetch.

Parameters:	result (int) – result of the fetch lock operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterGet(event)[source]¶

Called after a field view is retrieved.

Params event:	undocumented.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterInit(result)[source]¶

Called after a view is initialized.

Parameters:	result (int) – result of the initialization, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterInsert(result)[source]¶

Called after a view is inserted.

Parameters:	result (int) – result of the insert operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterPost(result)[source]¶

Called after a view is posted.

Parameters:	result (int) – result of the post operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterProcess(result)[source]¶

Called after a view finishes processing.

Parameters:	result (int) – result of processing, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterPut(event)[source]¶

Called after a value is put in the view.

Params event:	undocumented.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterRead(result)[source]¶

Called after a record is read through the view.

Parameters:	result (int) – result of the read operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterReadLock(result)[source]¶

Called after a view releases a lock for a read.

Parameters:	result (int) – result of the read lock operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterRecordClear(result)[source]¶

Called after a view is cleared.

Parameters:	result (int) – result of the clear operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterUnlock(result)[source]¶

Called after a view is unlocked.

Parameters:	result (int) – result of the unlock operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterUpdate(result)[source]¶

Called after a view is updated.

Parameters:	result (int) – result of the update operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onAfterVerify(result)[source]¶

Called after a view is verified.

Parameters:	result (int) – result of the verify operation, 0 on success.
Return type:	None

poplar_oeaddlne.resources.all_view_calls.onBeforeAttributes(event)[source]¶

Called before the attributes of a view field are changed.

Params event:	undocumented.
Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeCancel()[source]¶

Called before a record is canceled through the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeClose()[source]¶

Called before a view is closed.

Return type:	int
Returns:	`accpac.Continue` to allow the close, `accpac.Abort` to disallow it.

poplar_oeaddlne.resources.all_view_calls.onBeforeCompose(event)[source]¶

Called before a view is composed.

Parameters:	event (`accpac.viewComposeArgs`) – compose event information.
Returns:	must return `accpac.Continue` or the view will not load.
Return type:	int

Get the handles for composed views to make it easier to work with related data.

A script attached to the Order Header OE0520 view can access the composed Order Details OE0522 view. Get a handle on before compose, store it in the __main__ (script) namespace, and use it in other calls.

oeordd = None
def onBeforeCompose(event):
    if len(event.views):
        oeordd = event.views[0]

def onAfterPut(result):
    # If the put succeeded and a field = value, add a new order line
    if result == 0 and me.get("FIELD") == "VALUE":
        r = oeordd.recordClear()
        r = oeordd.recordGenerate()
        r = oeordd.put(...)
        ...

poplar_oeaddlne.resources.all_view_calls.onBeforeDelete()[source]¶

Called before a record is deleted through the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeDirty()[source]¶

Called before a view is marked dirty.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeFetch()[source]¶

Called before a record is fetched through the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeFetchLock()[source]¶

Called before a view locks for a fetch.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeGet(event)[source]¶

Called before the value of a field is retrieved through the view.

Params event:	undocumented.
Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeInit()[source]¶

Called before a view is initialized.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeInsert()[source]¶

Called before a record is inserted into the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforePost()[source]¶

Called before a record is posted through the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeProcess()[source]¶

Called before a view runs processing.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforePut(event)[source]¶

Called before the value of a field is put in a view field.

Params event:	undocumented.
Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeRead()[source]¶

Called before a record is read from the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeReadLock()[source]¶

Called before a view locks for a read.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeRecordClear()[source]¶

Called before a view is cleared.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeUnlock()[source]¶

Called before a view is unlocked.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeUpdate()[source]¶

Called before a record is updated through the view.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onBeforeVerify()[source]¶

Called before a view is verified.

Returns:	`accpac.Continue` or `accpac.Abort`
Return type:	int

poplar_oeaddlne.resources.all_view_calls.onCommitRecord(op)[source]¶

Called when a record in the revision list has been posted.

Parameters:

op (int) –

operation code, one of:

1 = insert
2 = update
3 = delete
4 = move

Return type: None

poplar_oeaddlne.resources.all_view_calls.onOpen()[source]¶

Called when a view is opened.

Return type:	int
Returns:	`accpac.Continue` to enable the script, 0 to disable, anything else stops the view loading.

poplar_oeaddlne.resources.all_view_calls.onOpenReadOnly()[source]¶

Called when a view is opened in readonly mode.

Return type:	int
Returns:	`accpac.Continue` to enable the script, 0 to disable, anything else stops the view loading.

poplar_oeaddlne.resources.all_view_calls.onRevisionCancelled()[source]¶

Called when the revision list is cancelled, changes are discarded.

Return type:	None

poplar_oeaddlne.resources.all_view_calls.onRevisionPosted()[source]¶

Called when a revision has been posted.

Return type:	None