Class TColoringLimit

DescriptionHierarchyFieldsMethodsProperties

Unit

DataSetUnit

Declaration

type TColoringLimit = class(TPersistent)

Description

When the grid is colored by a TDataArray, the colors can be restricted to lie within a range. TColoringLimit is used to represent one end of the range. See TColoringLimits.

Hierarchy

Overview

Fields

Private FBooleanLimitValue: boolean;
Private FDataType: TRbwDataType;
Private FDefaultBooleanLimitValue: boolean;
Private FIntegerLimitValue: integer;
Private FRealLimitValue: double;
Private FStringLimitValue: string;
Private FUseLimit: boolean;
Private FOnChange: TNotifyEvent;

Methods

Private procedure SetBooleanLimitValue(const Value: boolean);
Private procedure SetDataType(const Value: TRbwDataType);
Private procedure SetIntegerLimitValue(const Value: integer);
Private procedure SetRealLimitValue(const Value: double);
Private procedure SetStringLimitValue(const Value: string);
Private procedure SetUseLimit(const Value: boolean);
Public procedure Assign(Source: TPersistent); override;
Public constructor Create;

Properties

Public property DefaultBooleanLimitValue: boolean read FDefaultBooleanLimitValue write FDefaultBooleanLimitValue;
Public property OnChange: TNotifyEvent read FOnChange write FOnChange;
Published property BooleanLimitValue: boolean read FBooleanLimitValue write SetBooleanLimitValue;
Published property DataType: TRbwDataType read FDataType write SetDataType;
Published property IntegerLimitValue: integer read FIntegerLimitValue write SetIntegerLimitValue;
Published property RealLimitValue: double read FRealLimitValue write SetRealLimitValue;
Published property StringLimitValue: string read FStringLimitValue write SetStringLimitValue;
Published property UseLimit: boolean read FUseLimit write SetUseLimit;

Description

Fields

Private FBooleanLimitValue: boolean;

See BooleanLimitValue.

Private FDataType: TRbwDataType;

See DataType.

Private FDefaultBooleanLimitValue: boolean;

See DefaultBooleanLimitValue.

Private FIntegerLimitValue: integer;

See IntegerLimitValue.

Private FRealLimitValue: double;

See RealLimitValue.

Private FStringLimitValue: string;

See StringLimitValue.

Private FUseLimit: boolean;

See UseLimit.

Private FOnChange: TNotifyEvent;

See OnChange.

Methods

Private procedure SetBooleanLimitValue(const Value: boolean);

See BooleanLimitValue.

Private procedure SetDataType(const Value: TRbwDataType);

See DataType.

Private procedure SetIntegerLimitValue(const Value: integer);

See IntegerLimitValue.

Private procedure SetRealLimitValue(const Value: double);

See RealLimitValue.

Private procedure SetStringLimitValue(const Value: string);

See StringLimitValue.

Private procedure SetUseLimit(const Value: boolean);

See UseLimit.

Public procedure Assign(Source: TPersistent); override;

Assign copies those parts of Value that are used to the current instance of TColoringLimit (except for OnChange).

Public constructor Create;

Create creates an instance of TColoringLimit.

Properties

Public property DefaultBooleanLimitValue: boolean read FDefaultBooleanLimitValue write FDefaultBooleanLimitValue;

DefaultBooleanLimitValue is the value to used for BooleanLimitValue when UseLimit is False.

Public property OnChange: TNotifyEvent read FOnChange write FOnChange;

If there is a change in UseLimit, BooleanLimitValue, IntegerLimitValue, RealLimitValue, or StringLimitValue, OnChange can be used to respond to that change. Changing to DataType does not cause an OnChange event to occur.

Published property BooleanLimitValue: boolean read FBooleanLimitValue write SetBooleanLimitValue;

If DataType is rdtBoolean and UseLimit is True, BooleanLimitValue is the boolean value used to limit what values will be used to color the grid.

Published property DataType: TRbwDataType read FDataType write SetDataType;

DataType indicates the data type (real, integer, boolean, or string) of the TDataArray or TCustomModflowGridEdgeDisplay to which this limit applies.

Published property IntegerLimitValue: integer read FIntegerLimitValue write SetIntegerLimitValue;

If DataType is rdtInteger and UseLimit is True, IntegerLimitValue is the integer value used to limit what values will be used to color the grid.

Published property RealLimitValue: double read FRealLimitValue write SetRealLimitValue;

If DataType is rdtDouble and UseLimit is True, RealLimitValue is the real value used to limit what values will be used to color the grid.

Published property StringLimitValue: string read FStringLimitValue write SetStringLimitValue;

If DataType is rdtString and UseLimit is True, StringLimitValue is the string value used to limit what values will be used to color the grid.

Published property UseLimit: boolean read FUseLimit write SetUseLimit;

UseLimit indicates whether this TColoringLimit should be used to limit what values are used to color the grid.

Generated by PasDoc 0.12.1 on 2013-05-13 15:41:30