SubfileControlAttribute class | QSYS API Reference Guide

Estimated reading time: 3 minutes

Defines Subfile Control Attribute on a type

Namespace: ASNA.QSys.Expo.Model Assembly: ASNA.QSys.Expo.Model.dll

Inheritance: Object –> Attribute –> BaseRecordAttribute –> RecordAttribute

Remarks

The SubfileControlAttribute class is a specialized class derived from RecordAttribute class that provides meta-data to express in the Model Subfile Control Displayfile Record DDS keywords.

The following excerpt of code describes to the Subfile Control model, several properties such as when to Clear the controlled Subfile, when to Display the records and fields.

[
    SubfileControl(ClearRecords : "90",
        FunctionKeys = "PageUp 51:!76;PageDown 50:!77",
        DisplayFields = "!90",
        DisplayRecords = "!90",
        Size = 20,
        IsExpandable = false,
        EraseFormats = "CUSTREC SALESREC"
    )
]
public class SFLC_Model : SubfileControlModel
{
    .
    .
    .
}

Note how the first attribute is passed as a parameter to the constructor (using colon syntax), while the rest as attributes to the class (using assignment syntax).

Constructors

Name Description
SubfileControlAttribute(String) Initializes a new SubfileControlAttribute instance.

SubfileControlAttribute(String)

Initializes a new SubfileControlAttribute instance.

SubfileControlAttribute(String)

Parameters

Type Parameter name Description
String ClearRecords Conditional Indicator expression that when true indicates that the Records in the Subfile should be cleared

Properties

Type Name Description
String ClearRecords Gets the conditional indicator expression that determines if the records of the Subfile should be cleared
String DisplayFields Gets the conditional indicator expression that determines if the Fields in the Subfile Controller should display
String DisplayRecords Gets the conditional indicator expression that determines if the Subfile Records should display
Int32 FoldDropIndicator Gets or Sets the Fold/Drop toggle indicator numeric value. Defaults to zero (Fold/Drop does not apply)
String InitializeRecords Gets the conditional indicator expression that determines if Subfile Records should be initialized
Boolean InitNotActive Gets or sets a boolean that, when set to “true”, when initializing the subfile records (because expression for InitializeRecords evaluates to true), the added records to the subfile will be non-active - meaning that they are not part of the subfile yet until the records are written to, or the user enters values into them -.
Boolean IsExpandable Gets or sets a boolean value indicating if the Subfile can expand
String ProgramQ Gets or sets the value of the PGMQ on a Message subfile
Int32 Size Gets or sets the Subfile Size. Defaults to zero records.

Methods

Signature Description
GetFrom(Type) Gets a SubfileControlAttribute from the Custom attributes on a type

SubfileControlAttribute GetFrom(Type type)

Gets a SubfileControlAttribute from the Custom attributes on a type

SubfileControlAttribute GetFrom(Type type)

Parameters

Type Parameter name Description
Type type Input object type

Returns

Type Description
SubfileControlAttribute the subfile control attribute