Workspace Class


( Information about overall display in Asprova. )

<ASGWorkspace> Interface

 

Property Overview

TabProperty NameData TypeDescription

General

Operation mode
(ASGWorkspace_OperationMode)

<Basic><Standard>

Enum

Filters properties to be displayed in table windows and the properties window.


ValueNameDescription
BasicBasicDisplays properties for which the Display in basic mode flag is set.
StandardStandard Displays properties for which the Display in standard mode flag is set.
CustomCustomDisplays properties for which the Display in custom mode flag is set.
DeveloperDeveloperDisplays properties for which the Display in developer mode flag is set.

 

String display method
(ASGWorkspace_StringDisplayMethod)

<Basic><Standard>
StringDisplayMethod

Enum

Specify here the type of strings to be displayed for the names of objects and properties.


ValueNameDescription
InternalValuesInternal valuesDisplays objects and properties by internal values.
StandardLocalizedStringsStandard localized stringsDisplays objects and properties by standard localized strings.
LocalizedStringsWithUserAliasesUser defined aliasesDisplays objects and properties by user defined aliases.

 

Workbook view
(ASGWorkspace_WorkbookMode)

<Basic><Standard>
WorkBookMode
<VARIANT_BOOL> Data Type

Bool

Toggles the workbook display mode.

 

Default font
(ASGWorkspace_DefaultFont)

<Basic><Standard>

Font

Default font used when opening a new window of the standard style.

Settings

Project folder name
(ASGWorkspace_ProjectPath)

<RO>
<Basic><Standard>
ProjectPathName
<BSTR> Data Type

String

Name of the folder of the project.

 

Project file name
(ASGWorkspace_ProjectFileName)

<RO>
<Basic><Standard>
ProjectFilename
<BSTR> Data Type

String

Name of the file of the project.

Obtains the file name of the currently opened project with extension.
 

User
(ASGWorkspace_User)

<RO>
<Standard>

Object

Object of the current user. Only used when connected to Asprova NLS/DS. The user objects are listed in the User table.

 

Tab display
(ASGWorkspace_DefaultWindowTabType)

<Basic><Standard>
WindowTabType

Enum

Specify whether to show style tabs when opening a new window


ValueNameDescription
NoTabsNoNewly opened windows will not show style tabs
StyleTabsBelow windowNewly opened windows will show style tabs below the window

 

Use existing windows
(ASGWorkspace_TableInstanceType)

<Standard>

Enum

When opening or jumping to a table or chart, specifies whether to re-use an existing window of that type of table/chart if possible, instead of creating another window.


ValueNameDescription
NoNoAlways create a new window when opening or jumping to a table/chart.
YesYesReuse an existing window of the same type if one exists.

 

Zoom method
(ASGWorkspace_ZoomMethod)

<Standard>

Enum

Change the zooming method when mouse wheel is turned while holding CTRL.


ValueNameDescription
0Simple zoomSimply zoom in and out no matter where the mouse cursor is.
1Enable vertical and horizontal zoomIn the charts, if the CTRL key is held and the mouse wheel is turned, if the cursor lies in the chart's left part, the chart's row heights will be adjusted. If the cursor lies in the chart's header, the chart's column widths will be adjusted. Also, for label objects whose [Shape] is Bubble, their sizes will not change no matter what the zoom is. Label object's sizes will be exactly as set in [Rectangle height] and [Rectangle width]. Table zooming remains the same as simple zoom.

 

Backup Ar3/Ar4/Aru folder path
(ASGWorkspace_BackupAr4FolderPath)

<Basic><Standard>
BackupFolderPath
<BSTR> Data Type

String

Specify the folder to save backup files as an absolute path or a path relative to the project path. When the folder is specified as a relative path, the folder will be automatically created if the folder does not exist. Example of a relative path: Backup (Backup folder of the folder in which the ar4 file exists.) Example of an absolute path: \\OtherPC\AsprovaBackup (AsprovaBackup folder in another machine)

 

Max number of Ar3/Ar4/Aru backup files
(ASGWorkspace_NumBackupAr4Files)

<Basic><Standard>
MaxNumberOfBackupFiles
<LONG> Data Type

Integer

If the number of backup files existing in the folder in which to save the backup of this file exceeds this value, the backup files will be deleted from the one with the oldest update date first when [File] - [Save] command is executed.

 

Style XML file folder path
(ASGWorkspace_StyleXMLFolderPath)

<Basic><Standard>

String

Specify the folder in which to save XML file representations of styles. If specified as a relative path to (this projects location) the folder specified will be created if it does not exist.

 

Show properties window
(ASGWorkspace_IsPropertyWindowVisible)

PropertyWindowVisible
<VARIANT_BOOL> Data Type

Bool

Internally used property.

 

Show object window
(ASGWorkspace_IsNavigationWindowVisible)

ObjectWindowVisible
<VARIANT_BOOL> Data Type

Bool

Internally used property.

 

Show message window
(ASGWorkspace_IsMessageWindowVisible)

MessageWindowVisible
<VARIANT_BOOL> Data Type

Bool

Internally used property.

 

Show custom menu
(ASGWorkspace_IsCustomMenu)

<RO>
CustomMenuActive
<VARIANT_BOOL> Data Type

Bool

Internally used property.

 

ASGWorkspace_IsObjectBrowserWindowVisible

Bool

 

 

Application shutdown save method
(ASGWorkspace_SaveModified)

<Standard>
SaveModified
<TSaveModified> Data Type

Enum

Method of saving files after asking the user whether or not to save, in cases where Asprova detects any changes when an application is closed.


ValueNameDescription
SerializeSerializeSerializes (binary save).
ExportExportExports. Performs the same process as exporting from the default menu through GUI.
SerializeAndExportSerialize and exportSerializes (binary save) and then exports.

 

Max objects shown in combo box
(ASGWorkspace_MaxObjectsShownInComboBox)

<Standard>

Integer

When the number of objects to show in a combo box exceeds this value, the combo box will not be displayed.

 

Properties window display method
(ASGWorkspace_PropertyWindowDisplayMethod)

<Standard>

Enum

Specify here how you want to display the properties window.


ValueNameDescription
NeverModalNever open dialogWhen an object is displayed in the properties window, does not open the properties window dialog but always use the properties window in a docked or floating state.
AlwaysModalAlways open dialogExcept when an object is clicked in a table or chart, opens a new properties window dialog when an object is displayed in the properties window.
ModalWhenJumpingFromPropertyWindowOpen dialog only when jumping from the properties windowOpens a new properties window dialog only when jumping from the properties window to another object.

 

Scheduling parameter list filter
(ASGWorkspace_ParamComboFilterExpr)

<Standard>

Expression

Specify which parameters should be shown in the scheduling parameter selection combo box.

 

Menu management
(ASGWorkspace_MenuManagement)

<Standard>

Enum

Select a menu management method. Ver.15 restricted feature. If logged into NLS/DS, only a project manager can change this property. A Ver.15 license is also required to change it.


ValueNameDescription
0Each userAllows each user to customize their own custom menu.
1Project managerProject manager will create and assign custom menus for each user. The user will also not be able to change the menu.

 

Style management
(ASGWorkspace_StyleManagement)

<Standard>

Enum

Select a style management method. Ver.15 restricted feature. If logged into NLS/DS, only a project manager can change this property. A Ver.15 license is also required to change it.


ValueNameDescription
0Each userAllows each user to manage the style settings. For MES and other non-scheduling modules, the style settings will be saved as an XML file on their machine.
1Project managerProject manager will create and specify the styles each user can use. Style XML files cannot be imported.

Locale

Display language
(ASGWorkspace_DisplayLanguage)

<RO>

Enum

Language in which menus, dialogs, property names, class names, and so on are displayed.


ValueNameDescription
chtChinese Big5 
ces  
deuGerman 
enuEnglish 
espSpanish 
fin  
fraFrench 
hun  
jpnJapanese 
korKorean 
pol  
rus  
tha  
tur  
chsChinese GB 
ptgPortuguese 

 

Encoding
(ASGWorkspace_CharEncoding)

<Standard>

Enum

Encoding of characters used for loading strings.


ValueNameDescription
932  
936  
949  
950  
1252  
1254  

 

Locale/Code page
(ASGWorkspace_LocaleCodePage)

<RO>

String

Locale and code page used for loading strings.

 

Locale
(ASGWorkspace_Locale)

<RO>

Object

Specify here information about displays that depend on locale, such as Asprova's date display and decimal point delimiters display.

 

Country
(ASGWorkspace_Country)

<Standard>

Enum

Specify here which country's holiday to display.


ValueNameDescription
NotSpecifiedNot specifiedNot specified
isIcelandIceland
irishIrelandIreland
azAzerbaijanAzerbaijan
afAfghanistanAfghanistan
usaUnited States of AmericaUnited States of America
aeUnited Arab EmiratesUnited Arab Emirates
dzAlgeriaAlgeria
arArgentinaArgentina
awArubaAruba
alAlbaniaAlbania
amArmeniaArmenia
aoAngolaAngola
adAndorraAndorra
yeYemenYemen
ukUnited KingdomUnited Kingdom
jewishIsraelIsrael
italianItalyItaly
iqIraqIraq
irIranIran
indianIndiaIndia
indonesianIndonesiaIndonesia
ugUgandaUganda
ukrainianUkraineUkraine
uzUzbekistanUzbekistan
uyUruguayUruguay
ecEcuadorEcuador
egEgyptEgypt
eeEstoniaEstonia
etEthiopiaEthiopia
erEritreaEritrea
svEl SalvadorEl Salvador
omOmanOman
dutchNetherlandsNetherlands
australianAustraliaAustralia
austrianAustriaAustria
kzKazakhstanKazakhstan
qaQatarQatar
canadianCanadaCanada
cmCameroonCameroon
khCambodiaCambodia
cvCabo VerdeCabo Verde
gaGabonGabon
gmGambiaGambia
ghGhanaGhana
ggGuernseyGuernsey
cyCyprusCyprus
cwCuracaoCuracao
cuCubaCuba
kgKyrgyzstanKyrgyzstan
gnGuineaGuinea
gwGuinea-BissauGuinea-Bissau
greekGreeceGreece
kwKuwaitKuwait
croatianCroatiaCroatia
gtGuatemalaGuatemala
guGuamGuam
glGreenlandGreenland
geGeorgiaGeorgia
gdGrenadaGrenada
kyCayman IslandsCayman Islands
keKenyaKenya
crCosta RicaCosta Rica
kmComorosComoros
coColumbiaColumbia
cgCongoCongo
cdDemocratic Republic of the CongoDemocratic Republic of the Congo
ciCote d'IvoireCote d'Ivoire
saudiarabianSaudi ArabiaSaudi Arabia
stSao Tome and PrincipeSao Tome and Principe
smSan MarinoSan Marino
zmZambiaZambia
slSierra LeoneSierra Leone
sySyrian Arab RepublicSyrian Arab Republic
singaporeSingaporeSingapore
djDjiboutiDjibouti
giGibraltarGibraltar
jmJamaicaJamaica
zwZimbabweZimbabwe
chSwitzerlandSwitzerland
swedishSwedenSweden
spainSpainSpain
srSurinameSuriname
lkSri LankaSri Lanka
slovakSlovakiaSlovakia
slovenianSloveniaSlovenia
szSwazilandSwaziland
sdSudanSudan
snSenegalSenegal
rsSerbiaSerbia
shSt. Helena, Ascension and Tristan da CunhaSt. Helena, Ascension and Tristan da Cunha
scSeychellesSeychelles
soSomaliaSomalia
thThailandThailand
tzTanzaniaTanzania
czechCzech RepublicCzech Republic
tdChadChad
tnTunisiaTunisia
clChileChile
danishDenmarkDenmark
ttRepublic of Trinidad and TobagoRepublic of Trinidad and Tobago
turkishTurkeyTurkey
tgTogoTogo
germanGermanyGermany
doDominican republicDominican republic
ngNigeriaNigeria
naNamibiaNamibia
niNicaraguaNicaragua
neNigerNiger
new_zealandNew zealandNew zealand
npNepalNepal
norwegianNorwayNorway
htHaitiHaiti
hungarianHungaryHungary
bsThe BahamasThe Bahamas
bmBermudaBermuda
bbBarbadosBarbados
bdBangladeshBangladesh
bhBahrainBahrain
pkPakistanPakistan
paPanamaPanama
pyParaguayParaguay
fjFijiFiji
philippinesPhilippinesPhilippines
finnishFinlandFinland
foFaroe IslandsFaroe Islands
frenchFranceFrance
brazilianBrazilBrazil
bulgarianBulgariaBulgaria
bfBurkina FasoBurkina Faso
biBurundiBurundi
prPuerto RicoPuerto Rico
vietnameseVietnamVietnam
bjBeninBenin
veVenezuelaVenezuela
byBelarusBelarus
beBelgiumBelgium
pePeruPeru
hnHondurasHonduras
baBosnia-HerzegovinaBosnia-Herzegovina
bwBotswanaBotswana
boBoliviaBolivia
portuguesePortugalPortugal
polishPolandPoland
ytMayotte IslandMayotte Island
moMacauMacau
mkMacedoniaMacedonia
mgMadagascarMadagascar
mwMalawiMalawi
mlMaliMali
mtMaltaMalta
mqMartiniqueMartinique
malaysiaMalaysiaMalaysia
mmMyanmarMyanmar
mexicanMexicoMexico
mzMozambiqueMozambique
mcMonacoMonaco
mdMoldovaMoldova
maMoroccoMorocco
mnMongoliaMongolia
meMontenegroMontenegro
muMauritiusMauritius
joJordanJordan
latvianLatviaLatvia
lithuanianLithuaniaLithuania
liLiechtensteinLiechtenstein
lyLibyaLibya
lrLiberiaLiberia
luLuxembourgLuxembourg
rwRwandaRwanda
romanianRomaniaRomania
lsLesothoLesotho
lbLebanonLebanon
reReunionReunion
russianRussiaRussia
chinaChinaChina
cfCentral African RepublicCentral African Republic
kpNorth KoreaNorth Korea
saSouth AfricaSouth Africa
ssSouth SudanSouth Sudan
taiwanTaiwanTaiwan
vaVatican CityVatican City
japaneseJapanJapan
viUS Virgin IslandsUS Virgin Islands
gqEquatorial GuineaEquatorial Guinea
south_koreaKoreaKorea
hong_kongHong KongHong Kong

 

Download national holidays during loading project
(ASGWorkspace_DownloadNationalHoliday)

<Standard>

Enum

Specify here whether to download national holidays from asprova.com during loading project. The countries which are set in [Country] properties of Resource table, workspace or styles will be downloaded.


ValueNameDescription
0NoDo not download
1YesDownload

 

Number format
(ASGWorkspace_LocaleNumberFormat)

<Standard>

Enum

Specify here a decimal point delimiter.


ValueNameDescription
DOTDotDisplays dots for decimal point delimiters.
COMMACommaDisplays commas for decimal point delimiters.

 

Date format
(ASGWorkspace_LocaleDateFormat)

<Standard>

Enum

Specify here a date format.


ValueNameDescription
YMDY/M/DSpecify YYYY/MM/DD as the date format.
MDYM/D/YSpecify MM/DD/YYYY for the date format.
DMYD/M/YSpecify DD/MM/YYYY for the date format.

 

Days of week format
(ASGWorkspace_LocaleDaysOfWeekFormat)

<Standard>

String

The first day is Sunday. Specify here a days of the week format displayed on the top part of the time chart.

 

Currency format
(ASGWorkspace_LocaleCurrencyFormatExpression)

<Standard>

Expression

Specify here a currency format

Common

Code
(Code)

<Basic><Standard>

String

Name of the object used internally. The code does not need to be unique including objects such as order. In that case, however, other property should be added to the DBIO primary key for a merge process during import and synchronization. Also, in cases where orders are specified by code such as for next orders, behavior is undefined.

 

Display name
(DisplayString)

<Standard>

String

Display name held internally in Asprova. If a value is set here, the display name will be displayed in place of the code. Starting with Ver4, single quotations (') are not allowed.

 

Alias
(DisplayAlias)

<Standard>

String

Specify here an alias of the object. If a value is set here, the alias will be displayed in place of its code or display name.
To display an alias, you need to select User defined aliases from [Workspace] - [General] - [String display method] (The default is set to this value). Starting with Ver4, single quotations (') are not allowed.

 

Comments (common)
(Comment)

<Multi>
<Standard>

String

Enter comments here. This property is common to each class and you can use it for Properties to be copied to operation from order of the Project class and so on.

 

Object ID
(ObjectID)

<RO>
<Standard>

Unsigned integer

ID number defined by each object.

 

Parent
(Parent)

<RO>
<Standard>

Object

The object at one level higher than this object.

 

Children
(Child)

<RO> <Multi>
<Standard>

Object

Objects at one level lower than this object.

 

Class definition
(Object_ClassDef)

<RO>
<Standard>

Object

Object that defines the class information of this object.

 

Internal status flag
(Object_StatusFlag)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed within Asprova.


ValueNameDescription
 NoneThis record has not been changed.
ANewly addedThis record has been newly added.
MModifiedThis record has been modified.
DDeletedThis record has been deleted.

 

Status flag
(Object_StatusFlagExt)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed outside Asprova.


ValueNameDescription
 NoneThis record has not been changed externally.
ANewly addedThis record has been newly added externally.
MModifiedThis record has been modified externally.
DDeletedThis record has been deleted externally.

 

Invalid flag
(Object_InvalidFlag)

<RO>
<Standard>

Bool

Indicates whether the object is invalid or not.

 

Reason to be invalidated
(ReasonToBeInvalidated)

<RO> <Multi>
<Standard>

Enum

Reason why the invalid flag is on.


ValueNameDescription
NNo valid master for order explosionNo valid master exists when orders are exploded.
LBMaster loop (master object)Master object in which a loop was detected.
LNMaster loop (master input instruction)Master input instruction in which a loop was detected.
LIMaster loop (item)Item in which a loop was detected.
FOrder explosion failureOrder explosion failed at last execution.
LIntegrated master loopItem that is detected to have a loop in the integrated master, and it's auto replenishment flag is not No.
GFailed to build groupsGroup hierachy exceeded the maximum limit of 20 levels deep.
GLFound a loop inside groupA loop has been detected inside a group.
D  
RUnneeded result operationRegarded as unneeded during the last order explosion but was not deleted because results data was specified for the operation.

 

Update time
(FlagDate)

<RO>
<Standard>

Time

Updated when import/export/synchronization is executed. Note that this is not the time at which data is changed through the GUI, rescheduling, and so on.

Internal

Global windows
(ASGWorkspace_GlobalViews)

<RO>
<Standard>

Object

Container of all currently-opened global windows.

 

Project windows
(ASGWorkspace_ProjectViews)

<RO> <Multi>
<Standard>
ActiveProjectViews
<ASGViews> Data Type

Object

Container of all windows currently opened for the project.

 

Active object
(ASGWorkspace_CurrentObject)

<RO>
<Standard>

Object

Object that is currently being displayed in the properties window.

 

Enable auto-registration
(ASGWorkspace_IsAutoRegistrationActive)

<RO>

Bool

Internally used property.

 

Internally used property
(ASGWorkspace_PlugInStatus)

<RO>

String

 

 

Internally used property
(ASGWorkspace_PlugInStatus_Key)

<RO>

String

 

 

Internally used property
(ASGWorkspace_EIIStatus)

<RO>

String

 

 

Last setting expression dialog table tab
(ASGWorkspace_LastSettingExpressionDialogTableTab)

Enum

Internally used property.


ValueNameDescription
StandardExpressionStandard registered expressions 
UserExpressionUser registered expressions 
FunctionInternal functions 

 

Last setting expression dialog more
(ASGWorkspace_LastSettingExpressionDialogMore)

Bool

Internally used property.

 

Palette
(ASGWorkspace_Palette)

<RO>
<Standard>
Palette
<ASGPalette> Data Type

Object

Customize various information about colors to be displayed on the screen.

 

Properties window dialog left
(ASGWorkspace_PropertyWindowDialogLeft)

Integer

The last position where the properties window dialog was displayed.

 

Properties window dialog top
(ASGWorkspace_PropertyWindowDialogTop)

Integer

The last position where the properties window dialog was displayed.

 

Properties window dialog width
(ASGWorkspace_PropertyWindowDialogWidth)

Integer

The last position where the properties window dialog was displayed.

 

Properties window dialog height
(ASGWorkspace_PropertyWindowDialogHeight)

Integer

The last position where the properties window dialog was displayed.

 

Expression dialog left
(ASGWorkspace_ExpressionDialogLeft)

Integer

Expression dialog last horizontal position

 

Expression dialog top
(ASGWorkspace_ExpressionDialogTop)

Integer

Expression dialog last vertical position

 

Expression dialog width
(ASGWorkspace_ExpressionDialogWidth)

Integer

Expression dialog last width

 

Expression dialog height
(ASGWorkspace_ExpressionDialogHeight)

Integer

Expression dialog last height

 

Possible solutions dialog left
(ASGWorkspace_MessageDetailDialogLeft)

Integer

Possible solutions dialog last horizontal position

 

Possible solutions dialog top
(ASGWorkspace_MessageDetailDialogTop)

Integer

Possible solutions dialog last vertical position

 

Possible solutions dialog width
(ASGWorkspace_MessageDetailDialogWidth)

Integer

Possible solutions dialog last width

 

Possible solutions dialog height
(ASGWorkspace_MessageDetailDialogHeight)

Integer

Possible solutions dialog last height

 

Command editor dialog left
(ASGWorkspace_CommandDialogLeft)

Integer

Command editor dialog last horizontal position

 

Command editor dialog top
(ASGWorkspace_CommandDialogTop)

Integer

Command editor dialog last vertical position

 

Command editor dialog width
(ASGWorkspace_CommandDialogWidth)

Integer

Command editor dialog last width

 

Command editor dialog height
(ASGWorkspace_CommandDialogHeight)

Integer

Command editor dialog last height

 

Current palette
(ASGWorkspace_CurrPalette)

<Standard>

Object

Current palette.

 

Select command dialog left
(ASGWorkspace_SelectCommandDialogLeft)

Integer

Select command dialog's last horizontal position.

 

Select command dialog top
(ASGWorkspace_SelectCommandDialogTop)

Integer

Select command dialog's last vertical position.

 

Select command dialog width
(ASGWorkspace_SelectCommandDialogWidth)

Integer

Select command dialog's last width.

 

Select command dialog height
(ASGWorkspace_SelectCommandDialogHeight)

Integer

Select command dialog's last height.

All Properties

User name
(ASGWorkspace_UserName)

<RO>
<Standard>
UserName
<BSTR> Data Type

String

Name of the user who is currently logged in. (Asprova NLS/Asprova DS)

 

Code/Display name/Alias
(Object_CodeDisplayNameOrAlias)

String

Corresponds to the code, display name or alias depending on the setting in the property String display method of the workspace.

 

Currently editing user code
(Object_UserDuringChangeCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Currently editing user. Mapped in DBIO's [Field mapping].

 

User with right to edit code
(Object_UserDuringCheckOutCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Reserved right to edit user. Mapped in DBIO's [Field mapping].

 

Owner code
(Object_OwnerUserCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Owner. Mapped in DBIO's [Field mapping].

 
 
DateFormat
<TDateFormat> Data Type

 

Sets locale date format.

 
NumberFormat
<TNumberFormat> Data Type

 

Specifies locale number format.

 
DaysOfWeekFormat
<BSTR> Data Type

 

Sets locale day-of-week strings.

 
PropertyWindow
<ASGPropertyWindow> Data Type
<RO>

 

Obtains the properties window.

 
ObjectWindow
<ASGObjectWindow> Data Type
<RO>

 

Obtains the object window.

 
MessageWindow
<ASGMessageWindow> Data Type
<RO>

 

Obtains the message window.


<RO> : Read-Only
<Multi> : Array Type (Starting From 1)

<Basic> : Displays in basic mode
<Standard> : Displays in standard mode

See Also

ASGMessageWindow, ASGObjectWindow, ASGPropertyWindow


HelpNo.:C40

© Since 2018 Asprova Corporation, All rights reserved.