Base interface for all five editor row types. General row information can be accessed via the IEditor interface. Note that this interface can be used to retrieve basic editor information only. For more detailed data, you should use one of the editor-specific interfaces: More...

Inheritance diagram for ZOSAPI.Editors.IEditorRow:

[legend]

Public Member Functions
IEditorCell	GetCellAt (int pos)
	Gets the cell at the specified index (IEditor.MinColumn to IEditor.MaxColumn).

Properties
IEditor	Editor `[get]`
	Gets the editor this row was retrieved from.

bool	IsValidRow `[get]`
	Gets a value indicating whether this instance is currently valid. Note that the RowIndex for this object is fixed, so removing one or more rows from the editor may cause it to be invalid.

int	RowIndex `[get]`
	Gets the index of this row in the editor.

string	RowTypeName `[get]`
	Gets the type of this row; this can be a surface for the LDE, object for the NCE, etc.

string	Bookmark `[get, set]`

Detailed Description

Base interface for all five editor row types. General row information can be accessed via the IEditor interface. Note that this interface can be used to retrieve basic editor information only. For more detailed data, you should use one of the editor-specific interfaces:

ZOSAPI.Editors.LDE.ILDERow (from ZOSAPI.Editors.LDE.ILensDataEditor.GetSurfaceAt)

ZOSAPI.Editors.NCE.INCERow (from ZOSAPI.Editors.NCE.INonSeqEditor.GetObjectAt)

ZOSAPI.Editors.MFE.IMFERow (from ZOSAPI.Editors.MFE.IMeritFunctionEditor.GetOperandAt)

ZOSAPI.Editors.TDE.ITDERow (from ZOSAPI.Editors.TDE.IToleranceDataEditor.GetOperandAt)

ZOSAPI.Editors.MCE.IMCERow (from ZOSAPI.Editors.MCE.IMultiConfigEditor.GetOperandAt)

Member Function Documentation

◆ GetCellAt()

IEditorCell ZOSAPI.Editors.IEditorRow.GetCellAt ( int pos )

Gets the cell at the specified index (IEditor.MinColumn to IEditor.MaxColumn).

Parameters

pos	The index of the cell to retrieve.

Returns

Examples: CSharpStandalone_03_open_file_and_optimise.cs, and CSharpStandalone_08_NSCEDetectorData.cs.

Property Documentation

◆ Bookmark

string ZOSAPI.Editors.IEditorRow.Bookmark

getset

◆ Editor

IEditor ZOSAPI.Editors.IEditorRow.Editor

get

Gets the editor this row was retrieved from.

The parent editor.

◆ IsValidRow

bool ZOSAPI.Editors.IEditorRow.IsValidRow

get

Gets a value indicating whether this instance is currently valid. Note that the RowIndex for this object is fixed, so removing one or more rows from the editor may cause it to be invalid.

true if this instance is a valid row; otherwise, false.

◆ RowIndex

int ZOSAPI.Editors.IEditorRow.RowIndex

get

Gets the index of this row in the editor.

The index of the row.

◆ RowTypeName

string ZOSAPI.Editors.IEditorRow.RowTypeName

get

Gets the type of this row; this can be a surface for the LDE, object for the NCE, etc.

The name of the row type.

ZOS-API interface 2024 R2 SP02

ZOSAPI.Editors.IEditorRow Interface Reference

Public Member Functions

Properties