BeginEdit Method

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Syntax

ApplicationMgr.BeginEdit ( editedFile, editKind, objectsToEdit)

Return Value

Boolean

Returns True when the application cancels the edit operation. When the application cancels the edit operation, do not modify the objectsToEdit parameter.

Purpose

Call this method before using the TestStand API to edit files the Application Manager and SequenceFileView Manager controls display. This method generates an ApplicationMgr.BeginEdit event to notify the application about the edit.

Remarks

Always make a corresponding call to the ApplicationMgr.EndEdit method after you modify the objectsToEdit parameter. Call the ApplicationMgr.EndEdit method even when the application cancels the edit. Do not call the ApplicationMgr.BeginEdit or ApplicationMgr.EndEdit methods when you execute a Command object to perform an edit. The Command object automatically calls the ApplicationMgr.BeginEdit and ApplicationMgr.EndEdit methods.

Parameters

editedFile As PropertyObjectFile

[In] Specifies the file you are editing.

editKind As EditKinds

[In] Specifies the kind of edit you are making.

objectsToEdit As Object Array

[In] Specifies the objects you are modifying.


See Also

ApplicationMgr

ApplicationMgr.BeginEdit event

ApplicationMgr.CanEdit

ApplicationMgr.EndEdit

Command

Command.Execute

SequenceFileViewMgr

WAS THIS ARTICLE HELPFUL?

Not Helpful