Skip to content

AlertInformDontShowAgain.md

Latest commit

 

History

History
114 lines (97 loc) · 3.53 KB

AlertInformDontShowAgain.md

File metadata and controls

114 lines (97 loc) · 3.53 KB
Raw

AlertInformDontShowAgain

Description

Displays an alert dialog which provides the user an information about the result of a command with an option to not show the dialog again. It offers no user choices.

The parameter 'arrOptions' is of type ARRAY [1..3] OF STRING;
arrOpt[1] - Saved setting category to save checkbox value
arrOpt[2] - Saved setting item to save checkbox value
arrOpt[3] - Specify the string to use in overriding the default 'Dont show this dialog again' checkbox string

PROCEDURE AlertInformDontShowAgain(
				text       : STRING;
				advice     : STRING;
				minorAlert : BOOLEAN;
				arrOptions : ARRAY);
def vs.AlertInformDontShowAgain(text, advice, minorAlert, arrOptions):
    return None

Parameters

Name Type Description
text STRING The information to be displayed.
advice STRING The text to be added in a smaller font under the main information message.
minorAlert BOOLEAN The severity of the alert: minor(true) or major(false).
arrOptions ARRAY ARRAY [1..3] OF STRING;

Remarks

Created by TTF 1/9/2009

Examples

VectorScript

PROCEDURE Example;
VAR
	result :INTEGER;
	arrayText : ARRAY[1..3] OF STRING;

BEGIN
	arrayText[1] := 'DontShowDialogAgainCategory';
	arrayText[2] := 'DontShowDialogAgainItem'; {Should be unique for every AlertInformDontShowAgain}
	arrayText[3] := '';

	AlertInformDontShowAgain('This is an invalid item.', '', false, arrayText);
END;
RUN(Example);

Python

def Example():
	arrayText = ('DontShowDialogAgainCategory',
				'DontShowDialogAgainItem', #{Should be unique for every AlertInformDontShowAgain}
				'')

        # python uses a tuple
	vs.AlertInformDontShowAgain('This is an invalid item.', '', False, arrayText);
Example()
PushAttrs;
Options[1] := 'Spotlight'; {Saved xml Category}
Options[2] := 'SeatingLayoutPick'; {Saved xml Item}
Options[3] := ''; {Check Box String}
AlertInformDontShowAgain(GetPlugInString(3010),'', FALSE, Options);
PenFore(45000, 45000, 45000);
SetPref(9871, TRUE);
GetOrigin(OriginX,OriginY);
Is3dView := GetProjection(ActLayer)<>6;

BEGIN
arrOpt[1] := 'DrawingBorder';
arrOpt[2] := 'TooManyFields';
arrOpt[3] := '';
AlertInformDontShowAgain(GetPlugInString(12000),GetPlugInString(12001),FALSE,arrOpt);
{AlrtDialog(Concat(gNumProjFields,':',gNumSheetFields,':',gNumGeneralFields,':',gNumTolFields));}
END;

	{ If Two-Fer Object was flipped without the lighting devices, alert the user that the flipped object may be incorrect }
	arrayText[1] := 'Spotlight';
	arrayText[2] := 'TwoFer';
	arrayText[3] := '';
	IF LightIndex = 1 THEN AlertInformDontShowAgain( GetPluginString(3000), GetPluginString(3001), FALSE, arrayText );
END;
import vs

# Displays an alert dialog which provides the user an information about the
# result of a command with an option to not show the dialog again.
text = 'Example text'
advice = 'Example'
minorAlert = True
arrOptions = []

vs.AlertInformDontShowAgain(text, advice, minorAlert, arrOptions)

See Also

VS Functions: AlertInform | AlertQuestion | AlertCritical | AlertQuestionDontShowAgain

Version

Availability: from Vectorworks 2010

Category