C# Class SharpPlant.SharpPlantReview.SprAnnotation

Provides the properties for controlling text annotations in SmartPlant Review.
Inheritance: SprDbObject
Mostra file Open project: phusband/SharpPlant Class Usage Examples

Private Properties

Property Type Description
GetCenterPoint SprPoint3D
GetImage Image
GetLeaderPoint SprPoint3D

Public Methods

Method Description
EditLeader ( ) : void

Prompts a user to select new leader points for an existing annotation. DisplayLeader will automatically be set to true.
Place ( ) : void

Prompts a user to place the current annotation.
SendToTextWindow ( ) : void

Updates the SmartPlant Review text window with the SprAnnotation text.
SprAnnotation ( ) : System
SprAnnotation ( DataRow dataRow ) : System
ToString ( ) : string

Converts the current annotation to a string representation.

Protected Methods

Method Description
GetDataRow ( ) : DataRow
GetDefaultRow ( ) : DataRow

Private Methods

Method Description
GetCenterPoint ( ) : SprPoint3D
GetImage ( ) : Image
GetLeaderPoint ( ) : SprPoint3D

Method Details

EditLeader() public method

Prompts a user to select new leader points for an existing annotation. DisplayLeader will automatically be set to true.
public EditLeader ( ) : void
return void

GetDataRow() protected method

protected GetDataRow ( ) : DataRow
return System.Data.DataRow

GetDefaultRow() protected method

protected GetDefaultRow ( ) : DataRow
return System.Data.DataRow

Place() public method

Prompts a user to place the current annotation.
public Place ( ) : void
return void

SendToTextWindow() public method

Updates the SmartPlant Review text window with the SprAnnotation text.
public SendToTextWindow ( ) : void
return void

SprAnnotation() public method

public SprAnnotation ( ) : System
return System

SprAnnotation() public method

public SprAnnotation ( DataRow dataRow ) : System
dataRow System.Data.DataRow
return System

ToString() public method

Converts the current annotation to a string representation.
public ToString ( ) : string
return string