Interface ZOSAPI::Editors::IEditorRow

Definition:

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)

Inherited by:

• ZOSAPI.Editors.LDE.ILDERow
• ZOSAPI.Editors.MCE.IMCERow
• ZOSAPI.Editors.MFE.IMFERow
• ZOSAPI.Editors.NCE.INCERow
• ZOSAPI.Editors.TDE.ITDERow

Members

• Bookmark
• Editor
• GetCellAt
• IsValidRow
• RowIndex
• RowTypeName

Properties

Property Editor

Definition:

IEditor ZOSAPI.Editors.IEditorRow.Editor

Gets the editor this row was retrieved from.

The parent editor.

Return type: IEditor

Property IsValidRow

Definition:

bool ZOSAPI.Editors.IEditorRow.IsValidRow

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.

Return type: bool

Property RowIndex

Definition:

int ZOSAPI.Editors.IEditorRow.RowIndex

Gets the index of this row in the editor.

The index of the row.

Return type: int

Property RowTypeName

Definition:

string ZOSAPI.Editors.IEditorRow.RowTypeName

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.

Return type: string

Property Bookmark

Definition:

string ZOSAPI.Editors.IEditorRow.Bookmark

Return type: string

Public functions

Function 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:

Parameters:

• int pos

Return type: IEditorCell