2.0 Settings
Accessing PlanSwift Settings
Settings are the root setting for PlanSwift. They are the default configuration settings for PlanSwift and can be written, read, and modified. Custom settings can also be added. To obtain the Advanced Properties of Settings, double click on Settings (red arrow in Figure 2-1).
API Calls:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
end
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
End Sub
begin
settings := PlanSwift.getItem('\Settings');
end
Figure 2-1
See Figures 2-2, 2-3, and 2-4 for the Settings Advanced Properties window. All of the available Settings items are displayed in these three figures. API calls for each of these are covered below in the order of the red arrowed numbers.
Figure 2-2
Figure 2-3
Figure 2-4
The settings are listed below:
Item
1. Name (see arrow 1 of Figure 2-2)
String value containing the property name.
API Calls:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("Name");
console.WriteLn(property.ResultAsString())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","Name")
console.WriteLn(property.ResultAsString)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('Name');
WriteLn(property.ResultAsString())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','Name');
WriteLn(property.ResultAsString())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("Name")
Console.WriteLn(property.ResultAsString());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","Name")
Console.WriteLn(property.ResultAsString)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('Name');
ShowMessage(property.ResultAsString);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','Name');
ShowMessage(property.ResultAsString);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsString(settings,'Name'));
end
//or
begin
ShowMessage(GetResultAsString('\Settings','Name'));
end
2. Icon (see arrow 2 of Figure 2-2)
String value for the PlanSwift icon.
API Calls:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("Icon");
console.WriteLn(property.ResultAsString())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","Icon")
console.WriteLn(property.ResultAsString)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('Icon');
WriteLn(property.ResultAsString())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','Icon');
WriteLn(property.ResultAsString())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("Icon")
Console.WriteLn(property.ResultAsString());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","Icon")
Console.WriteLn(property.ResultAsString)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('Icon');
ShowMessage(property.ResultAsString);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','Icon');
ShowMessage(property.ResultAsString);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsString(settings,'Icon'));
end
//or
begin
ShowMessage(GetResultAsString('\Settings','Icon'));
end
Other
5. ShowWelcome
Boolean value determining whether the Welcome to PlanSwift screen (Figure ??) is displayed. The Welcome screen requires the user to enter a Customer # and a PIN # in order to log in to the PlanSwift Professional mode (Figure ??) and not be in Viewer-only mode (Figure ??0).
When checked (true), the Welcome screen will be displayed when the software starts up, whether the software has been activated or not.
If it is not checked and the user has activated PlanSwift, then the Welcome screen will not appear at startup.
If it is not checked and PlanSwift has not been activated, then PlanSwift will load in the Viewer mode. Any attempts to command the software will cause the Activate PlanSwift Professional window to appear, requiring the entry of the Customer # and Pin # before PlanSwift can be put into its Professional mode.
API-Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("ShowWelcome");
console.WriteLn(property.ResultAsString())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","ShowWelcome")
console.WriteLn(property.ResultAsString)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('ShowWelcome');
WriteLn(property.ResultAsString())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','ShowWelcome');
WriteLn(property.ResultAsString())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("ShowWelcome")
Console.WriteLn(property.ResultAsString());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","ShowWelcome")
Console.WriteLn(property.ResultAsString)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('ShowWelcome');
ShowMessage(property.ResultAsString);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','ShowWelcome');
ShowMessage(property.ResultAsString);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsString(settings,'ShowWelcome'));
end
//or
begin
ShowMessage(GetResultAsString('\Settings','ShowWelcome'));
end
Figure xx
Figure ??
Figure ??
6. Left
Read-only integer value that displays the left position of the Main Window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("Left");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","Left")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('Left');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','Left');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("Left")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","Left")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('Left');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','Left');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'Left'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','Left'));
end
7. Top
Read-only interger value that displays the top position of the Main Window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("Top");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","Top")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('Top');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','Top');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("Top")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","Top")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('Top');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','Top');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'Top'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','Top'));
end
8. Width
Reade-only integer value that displays the width of the Main Window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("Width");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","Width")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('Width');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','Width');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("Width")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","Width")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('Width');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','Width');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'Width'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','Width'));
end
9. Height
Read-only integer value that displays the height position of the Main Window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("Height");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","Height")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('Height');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','Height');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("Height")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","Height")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('Height');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','Height');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'Height'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','Height'));
end
10. WindowState
Read-only integer value that shows whether PlanSwift program window is minimized or maximized. A value of 0 is minimized and 1 is mazimized.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("WindowState");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","WindowState")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('WindowState');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','WindowState');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("WindowState")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","WindowState")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('WindowState');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','WindowState');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'WindowState'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','WindowState'));
end
11. PropertiesWindowLeft
Read-only integer value thatdisplays the left position of the Properties window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("PropertiesWindowLeft");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","PropertiesWindowLeft")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('PropertiesWindowLeft');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','PropertiesWindowLeft');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("PropertiesWindowLeft")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","PropertiesWindowLeft")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('PropertiesWindowLeft');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','PropertiesWindowLeft');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'PropertiesWindowLeft'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','PropertiesWindowLeft'));
end
12. PropertiesWindowTop
Read-only integer value that displays the top position of the Properties window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("PropertiesWindowTop");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","PropertiesWindowTop")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('PropertiesWindowTop');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','PropertiesWindowTop');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("PropertiesWindowTop")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","PropertiesWindowTop")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('PropertiesWindowTop');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','PropertiesWindowTop');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'PropertiesWindowTop'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','PropertiesWindowTop'));
end
13. PropertiesWindowWidth
Read-only integer value that displays the width of the Properties window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("PropertiesWindowWidth");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","PropertiesWindowWidth")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('PropertiesWindowWidth');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','PropertiesWindowWidth');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("PropertiesWindowWidth")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","PropertiesWindowWidth")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('PropertiesWindowWidth');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','PropertiesWindowWidth');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'PropertiesWindowWidth'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','PropertiesWindowWidth'));
end
14. PropertiesWindowHeight
Read-only integer that displays the height of the Properties window.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("PropertiesWindowHeight");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","PropertiesWindowHeight")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('PropertiesWindowHeight');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','PropertiesWindowHeight');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("PropertiesWindowHeight")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","PropertiesWindowHeight")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('PropertiesWindowHeight');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','PropertiesWindowHeight');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'PropertiesWindowHeight'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','PropertiesWindowHeight'));
end
15. SendErrorReport
Boolean value controlling whether error reports are sent to PlanSwift. Checked is true and sends error reports. Unchecked is false and does not send them.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("SendErrorReport");
console.WriteLn(property.ResultAsBoolean())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","SendErrorReport")
console.WriteLn(property.ResultAsBoolean)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('SendErrorReport');
WriteLn(property.RResultAsBoolean())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','SendErrorReport');
WriteLn(property.ResultAsBoolean())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("SendErrorReport")
Console.WriteLn(property.ResultAsBoolean());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","SendErrorReport")
Console.WriteLn(property.ResultAsBoolean)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('SendErrorReport');
ShowMessage(property.ResultAsBoolean);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','SendErrorReport');
ShowMessage(property.ResultAsBoolean);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsBoolean(settings,'SendErrorReport'));
end
//or
begin
ShowMessage(GetResultAsBoolean('\Settings','SendErrorReport'));
end
16. SendScreenshot
Boolean value controlling whether screen shots of errors are sent to PlanSwift. Checked is true and sends screenshots. Unchecked is false and does not send them.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("SendScreenshot");
console.WriteLn(property.ResultAsBoolean())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","SendScreenshot")
console.WriteLn(property.ResultAsBoolean)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('SendScreenshot');
WriteLn(property.RResultAsBoolean())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','SendScreenshot');
WriteLn(property.ResultAsBoolean())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("SendScreenshot")
Console.WriteLn(property.ResultAsBoolean());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","SendScreenshot")
Console.WriteLn(property.ResultAsBoolean)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('SendScreenshot');
ShowMessage(property.ResultAsBoolean);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','SendScreenshot');
ShowMessage(property.ResultAsBoolean);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsBoolean(settings,'SendScreenshot'));
end
//or
begin
ShowMessage(GetResultAsBoolean('\Settings','SendScreenshot'));
end
17. DigitizerSnapHotKey
Integer value that returns an ANSI key code (default code 114, key F3). Figure ?? shows where the DigitizerSnapHotKey assignment is made.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("DigitizerSnapHotKey");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","DigitizerSnapHotKey")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('DigitizerSnapHotKey');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','DigitizerSnapHotKey');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("DigitizerSnapHotKey")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","DigitizerSnapHotKey")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('DigitizerSnapHotKey');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','DigitizerSnapHotKey');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'DigitizerSnapHotKey'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','DigitizerSnapHotKey'));
end
Figure ??
18. AngleSnapHotKey
Integer value that returns an ANSI key code (default code 119, key F8). Figure ?? shows where the AngleSnapHotKey assignment is made.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("AngleSnapHotKey");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","AngleSnapHotKey")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('AngleSnapHotKey');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','AngleSnapHotKey');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("AngleSnapHotKey")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","AngleSnapHotKey")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('AngleSnapHotKey');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','AngleSnapHotKey');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'AngleSnapHotKey'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','AngleSnapHotKey'));
end
19. MagnifierHotKey
Integer value that returns an ANSI key code (default code 77). The letter M invokes the Magnefier command in PlanSwift (Figure ??).
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("MagnifierHotKey");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","MagnifierHotKey")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('MagnifierHotKey');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','MagnifierHotKey');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("MagnifierHotKey")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","MagnifierHotKey")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('MagnifierHotKey');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','MagnifierHotKey');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'MagnifierHotKey'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','MagnifierHotKey'));
end
20. DefaultAreaTransparency
Integer value that sets the Area transparency default. Values range from 0 to 255, with 100 being the default. Figure ?? shows the DefaultAreaTransparency controls in both the Settings screen and the U-T-H Settings / Advanced Properties. The Line Size default setting is not available.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("DefaultAreaTransparency");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","DefaultAreaTransparency")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('DefaultAreaTransparency');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','DefaultAreaTransparency');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("DefaultAreaTransparency")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","DefaultAreaTransparency")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('DefaultAreaTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','DefaultAreaTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'DefaultAreaTransparency'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','DefaultAreaTransparency'));
end
Figure ??
21. DefaultLinearTransparency
Integer value that sets the Linear transparency default. Values range from 0 to 255, with 100 being the default. Figure ?? shows the DefaultLinearTransparency controls in both the Settings screen and the U-T-H Settings / Advanced Properties.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("DefaultLinearTransparency");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","DefaultLinearTransparency")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('DefaultLinearTransparency');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','DefaultLinearTransparency');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("DefaultLinearTransparency")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","DefaultLinearTransparency")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('DefaultLinearTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','DefaultLinearTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'DefaultLinearTransparency'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','DefaultLinearTransparency'));
end
Figure ??
22. DefaultSegmentTransparency
Integer value that sets the Segment transparency default. Values range from 0 to 255, with 100 being the default. Figure ?? shows the DefaultSegmentTransparency controls in both the Settings screen and the U-T-H Settings / Advanced Properties.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("DefaultSegmentTransparency");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","DefaultSegmentTransparency")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('DefaultSegmentTransparency');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','DefaultSegmentTransparency');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("DefaultSegmentTransparency")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","DefaultSegmentTransparency")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('DefaultSegmentTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','DefaultSegmentTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'DefaultSegmentTransparency'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','DefaultSegmentTransparency'));
end
Figure ??
23. DefaultCountTransparency
Integer value that sets the Count transparency default. Values range from 0 to 255, with 100 being the default. Figure ?? shows the DefaultCountTransparency controls in both the Settings screen and the U-T-H Settings / Advanced Properties.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("DefaultCountTransparency");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","DefaultCountTransparency")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('DefaultCountTransparency');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','DefaultCountTransparency');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("DefaultCountTransparency")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","DefaultCountTransparency")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('DefaultCountTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','DefaultCountTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'DefaultCountTransparency'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','DefaultCountTransparency'));
end
Figure ??
24. DefaultNoteTransparency
Integer value that sets the Note transparency default. Values range from 0 to 255, with 100 being the default. Figure ?? shows the DefaultNoteTransparency controls in both the Settings screen and the U-T-H Settings / Advanced Properties.
API Call:
private void Main()
{
PlanSwift planswift = new PlanSwift();
IItem settings = planswift.GetItem(@"\Settings");
IPropertyObject property = settings.GetProperty("DefaultNoteTransparency");
console.WriteLn(property.ResultAsInteger())
}
//or
private void Main()
{
PlanSwift planswift = new PlanSwift();
IPropertyObject property = planswift.GetProperty(@"\Settings","DefaultNoteTransparency")
console.WriteLn(property.ResultAsInteger)
}
procedure main;
var
planswift: IPlanSwift;
settings: IItem;
property: IPropertyObject
begin
planswift := coPlanSwift.Create();
settings := planswift.getItem('\Settings');
property := planswift.GetProperty('DefaultNoteTransparency');
WriteLn(property.ResultAsInteger())
end
//or
procedure main;
var
planswift: IPlanSwift;
property:IPropertyObject;
begin
planswift := coPlanSwift.Create();
property := planswift.GetProperty('\Settings','DefaultNoteTransparency');
WriteLn(property.ResultAsInteger())
end;
Sub main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim settings = planswift.GetItem("\Settings")
Dim property = settings.GetProperty("DefaultNoteTransparency")
Console.WriteLn(property.ResultAsInteger());
End Sub
//or
Sub Main()
Dim planswift = CreateObject("PlanSwift9.PlanCenter")
Dim nameProperty = planswift.GetProperty("\Settings","DefaultNoteTransparency")
Console.WriteLn(property.ResultAsInteger)
End Sub
begin
settings := PlanSwift.getItem('\Settings');
property := settings.GetProperty('DefaultNoteTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
property := PlanSwift.GetProperty('\Settings','DefaultNoteTransparency');
ShowMessage(property.ResultAsInteger);
end
//or
begin
settings := getItem('\Settings');
ShowMessage(GetResultAsInteger(settings,'DefaultNoteTransparency'));
end
//or
begin
ShowMessage(GetResultAsInteger('\Settings','DefaultNoteTransparency'));
end
Figure ??