Properties: Proficy_WST.Waste Control

Action1ColumnVisible

Purpose	Show/hide the Action 1 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Action1ColumnVisible As Boolean

Action2ColumnVisible

Purpose	Show/hide the Action 2 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Action2ColumnVisible As Boolean

Action3ColumnVisible

Purpose	Show/hide the Action 3 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Action3ColumnVisible As Boolean

Action4ColumnVisible

Purpose	Show/hide the Action 4 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Action4ColumnVisible As Boolean

AmountColumnVisible

Purpose	Show/hide the Amount column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property AmountColumnVisible As Boolean

CommandDescription

	Purpose	Returns a string that tells what a specified command has done.
		Read-only
	Syntax	Property CommandDescription(CommandName) As String

CommentColumnVisible

Purpose	Show/hide the Comment column
Value	Show	True
	Hide	False
		Read/Write
Syntax		Property CommentColumnVisible As Boolean

CommentVisibility

	Purpose	Open a Comment dialog box.
		Read/Write
	Syntax	Property CommentVisibility As Boolean

CurrentAction1

Purpose

Set or retrieve the first action for the selected Waste detail row.

The selected action must be chosen from the Current Action1 list.
Action 1 becomes the first action in a tree. Once the Current Action 1 is set other actions that were included in the Current Action 1 list are now included in a Current Action 2 list.

Read/Write

Syntax

Property CurrentAction1 As String

CurrentAction1List

	Purpose	Returns a list of available actions from which one can be selected and set as Current Action 1.
		Read-only
	Syntax	Property CurrentAction1List As Variant

CurrentAction2

Purpose

Set or retrieve the second action for the selected Waste detail row.

Action 1 must be set before an Action 2 can be selected.
The selected action must be chosen from the Current Action 2 list.
Action 2 becomes the second action in a tree. Once the Current Action 2 is set other actions that were included in the Current Action 2 list are now included in a Current Action 3 list.

Read/Write

Syntax

Property CurrentAction2 As String

CurrentAction2List

	Purpose	Returns a list of available actions from which one can be selected and set as Current Action 2.
		Read-only
	Syntax	Property CurrentAction2List As Variant

CurrentAction3

Purpose

Set or retrieve the third action for the selected Waste detail row.

Action 2 must be set before an Action 3 can be selected.
The selected action must be chosen from the Current Action 3 list.
Action 3 becomes the third action in a tree. Once the Current Action 3 is set other actions that were included in the Current Action 3 list are now included in a Current Action 4 list.

Read/Write

Syntax

Property CurrentAction3 As String

CurrentAction3List

	Purpose	Returns a list of available actions from which one can be selected and set as Current Action 3.
		Read-only
	Syntax	Property CurrentAction3List As Variant

CurrentAction4

Purpose

Set or retrieve the fourth action for the selected Waste detail row.

Action 3 must be set before an Action 4 can be selected.
The selected action must be chosen from the Current Action 4 list.
Action 4 becomes the fourth action in a tree.

Read/Write

Syntax

Property CurrentAction4 As String

CurrentAction4List

	Purpose	Returns a list of available actions from which one can be selected and set as Current Action 4.
		Read-only
	Syntax	Property CurrentAction4List As Variant

CurrentAmount

	Purpose	Set the waste amount value for currently selected row.
		Read/Write
	Syntax	Property CurrentAmount As Single

CurrentComment

	Purpose	Returns a list of all comments associated with the current row.
		Read-only
	Syntax	Property CurrentComment As String

CurrentFault

	Purpose	Set the fault in a current row.
		Read/Write
	Syntax	Property CurrentFault As String

CurrentFaultList

	Purpose	Returns a list of valid fault values
		Read-only
	Syntax	Property CurrentFaultList As Variant

CurrentItemRow

	Purpose	Set the row number of current item.
		Read/Write
	Syntax	Property CurrentItemRow As Long

CurrentItemTime

	Purpose	Returns the start time of the current Waste row.
		Read-only
	Syntax	Property CurrentItemTime As Date

CurrentLocation

	Purpose	Set the location of the current row; the location must be selected from the Current Location list.
		Read/Write
	Syntax	Property CurrentLocation As String

CurrentLocationList

	Purpose	Returns a list of available locations from which one can be selected and set as the Current Location.
		Read-only
	Syntax	Property CurrentLocationList As Variant

CurrentReason1

Purpose

Set or retrieve the first reason for the selected Waste detail row.

The selected reason must be chosen from the Current Reason 1 list.
Reason 1 becomes the first reason in a tree. Once the Current Reason 1 is set other reasons that were included in the Current Reason 1 list are now included in a Current Reason 2 list.

Read/Write

Syntax

Property CurrentReason1 As String

CurrentReason1List

	Purpose	Returns a list of available reasons from which one can be selected and set as Current Reason 1.
		Read-only
	Syntax	Property CurrentReason1List As Variant

CurrentReason2

Purpose

Set or retrieve the second reason for the selected Waste detail row.

Reason 1 must be set before a Reason 2 can be selected.
The selected reason must be chosen from the Current Reason 2 list.
Reason 2 becomes the second reason in a tree. Once the Current Reason 2 is set other reasons that were included in the Current Reason 2 list are now included in a Current Reason 3 list.

Read/Write

Syntax

Property CurrentReason2 As String

CurrentReason2List

	Purpose	Returns a list of available reasons from which one can be selected and set as Current Reason 2.
		Read-only
	Syntax	Property CurrentReason2List As Variant

CurrentReason3

Purpose

Set or retrieve the third reason for the selected Waste detail row.

Reason 2 must be set before a Reason 3 can be selected.
The selected reason must be chosen from the Current Reason 3 list.
Reason 3 becomes the third reason in a tree. Once the Current Reason 3 is set other reasons that were included in the Current Reason 3 list are now included in a Current Reason 4 list.

Read/Write

Syntax

Property CurrentReason3 As String

CurrentReason3List

	Purpose	Returns a string that tells what a specified command has done.
		Read-only
	Syntax	Property CurrentReason3List As Variant

CurrentReason4

Purpose

Set or retrieve the fourth reason for the selected Waste detail row.

Reason 3 must be set before a Reason 4 can be selected.
The selected reason must be chosen from the Current Reason 4 list.
Reason 4 becomes the fourth reason in a tree.

Read/Write

Syntax

Property CurrentReason4 As String

CurrentReason4List

	Purpose	Returns a list of available reasons from which one can be selected and set as Current Reason 4.
		Read-only
	Syntax	Property CurrentReason4List As Variant

CurrentType

	Purpose	Set the Waste type value for the currently selected row.
		Read/Write
	Syntax	Property CurrentType As String

CurrentTypeList

	Purpose	Returns a list of available types from which one can be selected and set as the Current Type.
		Read-only
	Syntax	Property CurrentTypeList As Variant

DateTimeFormat

	Purpose	Set the format for the date and time.
		Read/Write
	Syntax	Property DateTimeFormat(FType As Byte) As String

DetailsOnly

	Purpose	Expand all of the summary rows to show all the detail data at once for the display's current time range.
		Read/Write
	Syntax	Property DetailsOnly As Boolean

DisplayOption

Purpose	Set any of the following display options. Note: Widths are in pixels.
	Read/Write
Syntax	Property DisplayOption(OptionName As String, [DontDraw As Boolean])
	Where [DontDraw As True] = Do not refresh the screen until all of the options that should be set are set. [DontDraw As False] = Refresh the screen after each option is set.
	Display Option	Description
	Action1Visible	Show/hide the Action 1 column.
	Action2Visible	Show/hide the Action 2 column.
	Action3Visible	Show/hide the Action 3 column.
	Action4Visible	Show/hide the Action 4 column
	Action1Width	Set the Action 1 column width.
	Action2Width	Set the Action 2 column width.
	Action3Width	Set the Action 3 column width.
	Action4Width	Set the Action 4 column width.
	AmountVisible	Show/hide the Amount column.
	CommentSplitterRatio	Set the Comment window size as a percentage of the Display window.
	CommentsVisible	Display/do not display the displays' comments.
	CommentVisible	Display/do not display the Comment column.
	DetailsOnly	Display event details only, no summary.
	EventFilterAmount	Filter a downtime event by amount, e.g. to show only downtime events that are more or equal to 10, set the value to 10. Important:: To enable EventFilterAmount, FilterEventsByAmount must be set to True.
	EventVisible	Display/do not display the Event column.
	ExpandAll	Expand/compress all rows in the display
	Expanded	Expand/compress the current row.
	FaultVisible	Display/do not display the Fault column.
	FilterEventsByAmount	Enable/disable EventFilterAmount.
	FontSize	Set the size of the fonts used in the display.
	FrozenColumns	Set the number of columns to fix in place when scrolling the cursor to the right.
	HyperlinkSplitterWidth	Set the width of the Hyperlink menu to the right of the control.
	LocationVisible	Show/hide the Location column.
	LocationWidth	Set the Location column width.
	MeasurementVisible	Show/hide the Measurement column/
	MeasurementWidth	Set the Measurement column width.
	NonConfirmedOnly	Display only event details that still require reasons to be selected.
	ProductVisible	Show/hide the Product column.
	Reason1Visible	Show/hide the Reason 1 column.
	Reason2Visible	Show/hide the Reason 2 column.
	Reason3Visible	Show/hide the Reason 3 column.
	Reason4Visible	Show/hide the Reason 4 column.
	Reason1Width	Set the Reason 1 column width.
	Reason2Width	Set the Reason 2 column width.
	Reason3Width	Set the Reason 3 column width.
	Reason4Width	Set the Reason 4 column width.
	StartDateVisible	Show/hide the Start Date column.
	SummaryDate	Set the format of the summary date, e.g. mm/dd/yy.
	SummaryTime	Set the format for the summary time, e.g. hh:mm:ss.
	TypeVisible	Show/hide the Type column.
	TypeWidth	Set the Type column width.

DisplayOptionDescription

	Purpose	Description of each display option by name.
		Read-only
	Syntax	Property DisplayOptionDescription(CommandName) As String

EndTime

	Purpose	End time of the current row.
		Read-only
	Syntax	Property EndTime As Date

EventColumnVisible

Purpose	Show/hide the Event column
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property EventColumnVisible As Boolean

EventFilterAmount

Purpose

Filter a downtime event by amount, e.g. to show only Waste events that are more than or equal to 10, set the value to 10.

Note: The unit of measurement is determined by what unit the Waste is being tracked in.

Important: To enable EventFilterAmount, the property FilterEventsByAmount must be set to True.

Read/Write

Syntax

Property EventFilterAmount As Single

FaultColumnVisible

Purpose	Show/hide the Fault column
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property FaultColumnVisible As Boolean

FilterEventsByAmount

Purpose	Enable/disable the property EventFilterAmount.
Value	Enable	True
	Disable	False
	Read/Write
Syntax	Property FilterEventsByAmount As Boolean

FrozenColumns

	Purpose	Keep selected columns "frozen" to the left side.
		Read/Write
	Syntax	Property FrozenColumns As Integer

GridFontSize

	Purpose	Set the size of the fonts used in the display.
		Read/Write
	Syntax	Property GridFontSize As Integer

HyperLinkMenuVisible

Purpose	Show/hide the Hyperlink menu.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property HyperLinkMenuVisible As Boolean

LastError

	Purpose	Display an error message describing the last error.
		Read-only
	Syntax	Property LastError As String

LocationColumnVisible

Purpose	Show/hide the Location column
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property LocationColumnVisible As Boolean

NonConfirmedOnly

Purpose	Display only unconfirmed Waste.
Value	Display unconfirmed only	True
	Display all waste	False
	Read/Write
Syntax	Property NonConfirmedOnly As Boolean

ProductColumnVisible

Purpose	Show/hide the Product column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property ProductColumnVisible As Boolean

Reason1ColumnVisible

Purpose	Show/hide the Reason 1 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Reason1ColumnVisible As Boolean

Reason2ColumnVisible

Purpose	Show/hide the Reason 2 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Reason2ColumnVisible As Boolean

Reason3ColumnVisible

Purpose	Show/hide the Reason 3 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Reason3ColumnVisible As Boolean

Reason4ColumnVisible

Purpose	Show/hide the Reason 4 column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property Reason4ColumnVisible As Boolean

ServerName

	Purpose	Set the Server name.
		Read-only
	Syntax	Property ServerName As String

SheetName

	Purpose	Set the name of the display that the control will display.
		Read/Write
	Syntax	Property SheetName As String

StartTime

	Purpose	Shows when the control started for the current session.
		Read-only
	Syntax	Property StartTime As Date

TimeColumnVisible

Purpose	Show/hide the Time column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property TimeColumnVisible As Boolean

TypeColumnVisible

Purpose	Show/hide the Type column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property TypeColumnVisible As Boolean

UnitsColumnVisible

Purpose	Show/hide the Units column.
Value	Show	True
	Hide	False
	Read/Write
Syntax	Property UnitsColumnVisible As Boolean

VisibleColumns

Purpose

OBSOLETE

Use specific column visibility properties.

Read/Write

Syntax

Property VisibleColumns As Long

Top