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

Example

1
2
3
public void AddRow()

public void AddRow(FacilityTag facility)

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

Example

1
public void AddRows(IEnumerable<FacilityTag> facilities)

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

The Export method exports data from a grid column, including its summary row, if configured. Supported formats include .csv, .html, and .txt. 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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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);
}

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

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

Example

A DataCell object is in the following namespace:

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

A DataCell has one public method:

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

A DataCell has four public properties:

1
2
3
4
5
6
7
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; }

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

Example

1
public string GetCellValue(int row, int column)

The GetColumnDefinition method retrieves the specified column configuration for the grid column.

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

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

The Refresh method resets the cache and gets all data for the control from the associated service.

The ResolveRelativeFacility method returns the resolved relative facility.

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.

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

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

The SetRowFacility method sets the facility that will be used for the grid row.

The SetSiteServiceAndFilter method assists in modifying the SiteService and Filter properties without causing the control to duplicate work between each property change.

The ShowFacilityFilterDialog method opens the CygNet Facility Filter dialog box.

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