tsc_PointStakeoutStoreEventArgs

This event arguments interface is passed to some event handlers in the stakeout workflow.  These handlers are invoked just before the point deltas form and before storing the as-staked point in the database.

Public members

tsc_PointStakeoutConfigInterface& Config;

An interface to the current stakeout configuration.  This interface allows the configuration to be read but not changed.

void Abort ();

Aborts the form and/or the as-staked point storing process and returns to the previous workflow step. Has no effect when this is not a 'before form' event.

tsc_String PointName () const;

Gets the name of the as-staked point as it is about to be used on a form or for storing the point.

tsc_String FeatureString () const;

Gets the feature code field of the as-staked point as it is about to be used on a form or for storing the point.

tsc_String Note () const;

Returns the current note for the as-staked point.

void  Note  (const char* note);

Sets the note for the as-staked point that is about to be stored.  The string may contain any textual data including newline (tsc_SurveyCore::Newline()) characters.  Avoid any other control characters.  The Job Review display allows the user to view or edit the note, and may also be exported with the job if the JobXml format is used.

void AddCustomSubRecord (tsc_DatabaseCustomType& type);

Available in SC version 2.10 and higher.

This method adds custom XML data to be attached to the point when it is stored. Supply a custom type to identify the record containing the data to be written.

If the Reviewable member of the type is true, this custom record (plus any other reviewable objects that are stored with the point) will be visible in the General Survey Job Review window when the point record is expanded.  See tsc_DatabaseCustomType for more information about custom records.