IDisplayFile interface | QSYS API Reference Guide

Estimated reading time: 4 minutes

Defines the interface for display files, providing methods and properties for interacting with display file records and formats.

Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll

Extends: doesn’t extend any other interfaces.

Properties

Type	Name	Description
Boolean	DisplayErrorMessages	Determines if the Error Message Subfile should be displayed.
Int16	FeedbackActiveWindowCursor	Displayfile Feedback Last Cursor position for Active Window record (row, col).
Byte	FeedbackAID	Displayfile Feedback Attention Identifier.
Int16	FeedbackCursor	Displayfile Feedback Last Cursor position (row, col).
String	FeedbackField	Displayfile Feedback last field name where cursor was positioned.
Int16	FeedbackFlags	Displayfile Feedback flags.
Int16	FeedbackLowestSubfile	Displayfile Feedback Lowest subfile Relative Record Number visible.
Int16	FeedbackSubfileCursorRRN	Gets or sets the subfile record number where the cursor was position when the AID key was pressed.
String	LastFormatName	Displayfile Feedback last format name where cursor was positioned.

Methods

Signature	Description
ClearSubfile(String)	Clear Subfile.
Close()	Close Display File.
DeactivateFormats(String, String)	De-activate Display File record formats.
DisplaySubfileRecords(String)	Display subfile records.
GetCurrentRow(String)	Get current row.
InitMessageSubfile(String, String, Char[])	Initializes Message subfile.
IsActive(String)	Determines if Record format is Active.
Open()	Open Display File.
Read()	Read Display File.
SetActive(String)	Set the record format as Active.
SetCurrentRow(String, Int32)	Set current row.
Update()	Update Display File.
Write()	Write Display File.

void ClearSubfile(string subfileName)

Clear Subfile.

void ClearSubfile(string subfileName)

Parameters

Type	Parameter name	Description
String	subfileName	Input subfile name.

void Close()

Close Display File.

void Close()

void DeactivateFormats(string formatNames, string excludeFormatChildren)

De-activate Display File record formats.

void DeactivateFormats(string formatNames, string excludeFormatChildren)

Parameters

Type	Parameter name	Description
String	formatNames	Input record format names.
String	excludeFormatChildren	Input child record formats to exclude.

void DisplaySubfileRecords(string subfileName)

Display subfile records.

void DisplaySubfileRecords(string subfileName)

Parameters

Type	Parameter name	Description
String	subfileName	Input subfile name.

int GetCurrentRow(string formatName)

Get current row.

int GetCurrentRow(string formatName)

Parameters

Type	Parameter name	Description
String	formatName	Input record format name.

Returns

Type	Description
Int32	Relative Record Number.

void InitMessageSubfile(string subfileName, string programQ, Char[] optionIndicators)

Initializes Message subfile.

void InitMessageSubfile(string subfileName, string programQ, Char[] optionIndicators)

Parameters

Type	Parameter name	Description
String	subfileName	Input subfile name.
String	programQ	Input Program Q.
Char[]	optionIndicators	Input option indicator collection.

bool IsActive(string formatName)

Determines if Record format is Active.

bool IsActive(string formatName)

Parameters

Type	Parameter name	Description
String	formatName	Input record format name.

Returns

Type	Description
Boolean	True if active, False otherwise.

void Open()

Open Display File.

void Open()

void Read()

Read Display File.

void Read()

void SetActive(string formatName)

Set the record format as Active.

void SetActive(string formatName)

Parameters

Type	Parameter name	Description
String	formatName	Input record format name.

void SetCurrentRow(string formatName, int row)

Set current row.

void SetCurrentRow(string formatName, int row)

Parameters

Type	Parameter name	Description
String	formatName	Input record format name.
Int32	row	Input Relative Record Number.

void Update()

Update Display File.

void Update()

void Write()

Write Display File.

void Write()