Fires when saving any schematic session. Returns TRUE if the session is saved by the framework, and FALSE if this is handled by the application.
[Visual Basic 6.0] Event IsSessionSavedByFramework(
saveByFramework As Boolean _
)
[Visual Basic .NET] Public Event IsSessionSavedByFramework As IsSessionSavedByFrameworkEventHandler
[C#] public event IsSessionSavedByFrameworkEventHandler IsSessionSavedByFramework
[C++]
HRESULT IsSessionSavedByFramework(
VARIANT_BOOL* saveByFramework
);
Parameters
saveByFramework [in, out]
saveByFramework is a parameter of type VARIANT_BOOL
Product Availability
Description
By default, when the schematic session is closed, Schematics asks user whether he wants to save the changes or not before closing it. If the IsSessionSavedByFramework event is set to return FALSE, Schematics will not ask anything
Note that if the session's SaveMode property is set, priority is given to this property: thus, if the IsSessionSavedByFramework event is set to return FALSE and if the SaveMode property is set to esriNgSaveByFramework, when the session is closed, user will be asked whether he wants to save the changes or not.
Remarks
For more details on the Schematics events' chaining during project closure, please see the Remarks section available from the INgProject Close method help-page.
In the following sample code lines, the IsSessionSavedByFramework call back returns False in any case.
Private WithEvents m_ngProject As esriSchematic.NgProject
...
Private Sub m_ngProject_IsSessionSavedByFramework(saveByFramework As Boolean)
saveByFramework = False
End Sub
See Also
Send feedback on this page