CygNet Grid Methods

Canvas > Using Canvas Controls and Objects > CygNet Grid > CygNet Grid Methods

CygNet Grid Methods

Method icon The CygNet Grid supports the following scripting methods.

See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.

Refer to the Canvas Demo Screens on GitHub for examples more detail on some of these methods.

Method Description

AddRow

The AddRow method adds a row to the grid. It can include a facility tag.

Example

public void AddRow()

public void AddRow(FacilityTag facility)

AddRows

The AddRows method adds rows to the grid. It can take an enumerated list of facility tags.

Example

public void AddRows(IEnumerable<FacilityTag> facilities)

BuildFromXML

Equals

The Equals method determines whether the specified object is equal to the current object.

Export

The Export method exports data from a grid column. Supported formats include CSV, HTML, and Text. Export from historical columns is not supported.

Example

The following example uses a button click event and edit box to provide a path to export to.

Objects.CsvExportButton.Click += new EventHandler(this.CsvExportButton_Click);

Objects.HtmlExportButton.Click += new EventHandler(this.HtmlExportButton_Click);

Objects.TextExportButton.Click += new EventHandler(this.TextExportButton_Click);

Objects.EditBox1.Initialize += new EventHandler(this.EditBox1_Initialize);

private void EditBox1_Initialize(object sender, EventArgs args)

{

Objects.EditBox1.Text = @"E:\temp\GridExport";

}

private void CsvExportButton_Click(object sender, EventArgs args)

{

Objects.CygNetGrid1.Export(Objects.EditBox1.Text + ".csv",

Canvas.Controls.Grid.GridExportFormat.Csv,

true);

}

private void HtmlExportButton_Click(object sender, EventArgs args)

{

Objects.CygNetGrid1.Export(Objects.EditBox1.Text + ".html",

Canvas.Controls.Grid.GridExportFormat.Html,

true);

}

private void TextExportButton_Click(object sender, EventArgs args)

{

Objects.CygNetGrid1.Export(Objects.EditBox1.Text + ".txt",

Canvas.Controls.Grid.GridExportFormat.Text,

true);

}

Focus

The Focus method sets the focus to the control to allow further operations.

GetCell

The GetCell method retrieves cell data from the grid. It returns a DataCell object.

Example

A DataCell object is in the following namespace:

public Canvas.Controls.Grid.CygNetGrid.DataCell GetCell(int row, int column)

A DataCell has one public method:

public virtual CygNet.Data.Core.FacilityTag GetAssociatedFacilityTag()

A DataCell has four public properties:

public CygNet.Data.Alarms.CygNetAlarmProperties.CygNetAlarmProperty AlarmDisplayProperty { get; }

public System.Windows.Media.Brush BackgroundColor { get; set; }

public CygNet.Data.Core.CygNetCoreProperties.CygNetProperty CoreDisplayProperty { get; }

public virtual object Value { get; set; }

GetCellValue

The GetCellValue method retrieves cell values from the grid. Parameters include row and column. Returns a string value.

Example

public string GetCellValue(int row, int column)

GetColumnDefinition

GetData

The GetData method returns data in a specified data format.

GetHashCode

The GetHashCode method returns a hash code for the current object.

GetType

The GetType method returns the runtime type of the current instance.

ReceiveNewFacilities

ReceiveNewSiteService

Refresh

The Refresh method refreshes the data in the control from the Current Value Service (CVS).

ResolveRelativeFacility

The ResolveRelativeFacility method returns the resolved relative facility.

SelectAll

The Select All method allows multi-row selection via script. If the SelectionMode property is Multiple or Extended, SelectAll will select all rows in a grid and the SelectedRows property will return the matching DataRow objects. SelectAll will not obviously change the selection if SelectionMode is Single.

SerializeObject

The SerializeObject method stores the object in memory so that it can be recreated when needed.

SetCellValue

The SetCellValue method can be used to add custom data to the grid. Parameters include row, column, and string value. Returns a Boolean value to indicate success or failure.

Example

public bool SetCellValue(int row, int column, string value)

SetRowFacility

ShowFacilityFilterDialog

ToString

The ToString method returns a string that represents the current object.

UpdateFacilityTagListFilter

The UpdateFacilityTagListFilter method changes the facility filter of the grid. The method ensures that the FacilitySource property is <Self>, updates the FacilityTagListFilter property, and then calls on the Refresh method.