Skip to main content

Aras Innovator Client Framework Reference

Aras Innovator Client Framework

Provides various objects to handle client side actions.

Objects

Name Description
arasProvides client side API.

Window Objects

Name Description
InstanceItem's view.
ItemShows Item contents.
MainThe topmost window of Aras Innovator, is identical to top object.
RelationshipShows Relationship grid.
TreeProvides TOC tree API.
WorkShows main grid.

ItemType Events

Name Description
OnBeforeNewFires before executing "New Item" or "New Relationship" command. If return false, the action will abort.
OnNewFires when executing "New Item" or "New Relationship" command, and will overwrite original function. If return false, the action will abort.
OnAfterNewFires after executing "New Item" or "New Relationship" command. If return false, the action will abort.
OnShowItemFires when opening an Item, and will overwrite original function. If return false, the action will abort.

Property Events

Property event is the cell event for Relationship grid.

Name Description
OnEditStartFires before user starts editing a cell. If return false, the action will abort.
OnEditFinishFires after user finishes editing a cell.
OnChangeCellFires when cell value changes.

RelationshipType Events

ReltionshipType event is the Relationship grid event.

Name Description
OnSelectRowFires when user select a row in Relationship grid.
OnInsertRowFires when user insert a row in Relationship grid.
OnDeleteRowFires when user delete a row in Relationship grid. If return false, the action will abort.

Comments

Popular posts from this blog

aras.uiShowItemEx Method (aras Object)

aras.uiShowItemEx Method Shows Item with Item node. Syntax aras.uiShowItem( itemNd , viewMode , isOpenInTearOff ) Parameters Name Type Description itemNd Object Required. Item node. viewMode String Optional. Unknown purpose but only supports the following values: tab view (Default) openFile new ※Each supported value will get same result. Therefore, call method and pass undefined for this parameter is OK. isOpenInTearOff Boolean Optional. Specifies whether show Item with tear-off window. true - open in a tear-off window. false - open in a tab. (Default) Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework

aras.uiShowItem Method (aras Object)

aras.uiShowItem Method Gets Item by Item ID and then shows the Item. Syntax aras.uiShowItem( itemTypeName , itemID , viewMode ) Parameters Name Type Description itemTypeName String Required. Name of the ItemType. itemID String Required. ID of the Item. viewMode String Optional. Unknown purpose but only supports the following values: tab view - This is default. openFile new ※Each supported value will get same result. Therefore, call method without this parameter is OK. Return Value An AsyncResult object or a Boolean. Returns AsyncResult object if the Item winodw is opened successfully, otherwise returns false. See Also aras Object Aras Innovator Client Framework

Search Tips in Aras Innovator

In "Jus Ask Innoavtor", we could learn some tips for querying data in simple search mode. But I would use those tips with examples to make it easier to understand. Suppose there are 5 records in my database. Exact String Matching Input words or terms without any special symbol will execute exact string matching. Input "A0119B/11101", 1 record returned. Input "A0119B", nothing returned. Input "11101", nothing returned. Approximate String Matching Use "*" or "%" as wildcard character to execute approximate string matching. Input "A0*", 2 records returned. Input "*1", 3 records returned. Input "*ED*", 2 records returned. Input "A*1*1", 1 record returned. Regular Expression Matching Use square brackets with simple regular expression to execute a query is acceptable, all allowed terms (which are tested by myself and refer to this article ) are sh...