IPdmHooks::BeforeUiDocPlacement



Your Ad Here

Description

An event occurs when the document’s full path is requested for such operations as Save (the first save of a new document), Save As, etc..

This method takes the type of the document. If you override the default processing of the event, the method returns the name and the full path of the document.

See AfterUiDocPlacement.

Syntax

oDocName, oPath, oMode = BeforeUiDocPlacement(iApp, iData, iOperation, iDocType)

Input: (Object) iApp

Pointer to the application.

Input: (Variant) iData

Not applicable.

Input: (Long) iOperation

A unique number, relative to the Cimatron E session, which identifies each event. For two consecutive events, the second (later) event will be identified by a greater number than the first.

This identifier is passed to both the Before and After methods of the event.

This gives you the ability to determine the scope of an event. Otherwise, due to event nesting, it would be difficult to associate a pair of Before and After method calls with one event.

Input: (DocumentEnumType) iDocType

Type of document.

Return: (String) oDocName

Name of .elt file.

Return: (String) oPath

Path name of the .elt file.

Return: (Integer) oMode

The event process mode as defined by the user:

Process

The user processes the event.

Continue

The user passes the control to Cimatron E; the default processing of the event will be performed.

Cancel

The user cancels the event’s processing.

 

Return to Cimatron Index


Your Ad Here