Label Class


( Comments shown on Charts. )

<ASBLabel> Interface

 

Property Overview

TabProperty NameData TypeDescription

General

Label string
(Label_String)

<Basic><Standard>
Text
<BSTR> Data Type

String

String shown on the label. \\n can be set for wrap, while \\t can be set for tab.

 

Display content
(Label_DisplayContent)

<Basic><Standard>
DisplayContent

Enum

Content shown on the label.


ValueNameDescription
SIndividualShow the text that set in the [Label string] property of the label.
CObject's commentIf the owner is use instruction, the operation's [Comments (common)] will be shown. if the owner is operation or order, it's [Comments (common)] will be shown. Able to be modified.
DData tip textThe data tip will be shown. Not able to be modified.

 

Horizontal alignment
(Label_TextHorizontalAlignment)

<Basic><Standard>
TextHorizontalAlignment

Enum

Specify the horizontal alignment for the label. Can be set to left, center or right.


ValueNameDescription
LeftLeftThe horizontal alignment of the label text will be left.
CenterCenterThe horizontal alignment of the label text will be center.
RightRightThe horizontal alignment of the label text will be right.

 

Vertical alignment
(Label_TextVerticalAlignment)

<Basic><Standard>
TextVerticalAlignment

Enum

Specify the vertical alignment for the label. Can be set to top, center or bottom.


ValueNameDescription
TopTopThe vertical alignment of the label text will be top.
CenterCenterThe vertical alignment of the label text will be center.
BottomBottomThe vertical alignment of the label text will be bottom.

 

Shape
(Label_Shape)

<Basic><Standard>
ShapeType
<TLabelShape> Data Type

Enum

Shape of the label.


ValueNameDescription
BBubbleShape of the label will be bubble.
TArrowShape of the label will be arrow.

 

Resource
(Label_Resource)

<Basic><Standard>
Resource
<ASBResource> Data Type

Object

Resource where the label shows.

 

Item
(Label_Item)

<Basic><Standard>
Item
<ASBItem> Data Type

Object

Item where the label shows.

 

Order
(Label_Order)

<Basic><Standard>
Order
<ASBOrder> Data Type

Object

Order where the label shows.

 

Operation
(Label_Operation)

<Basic><Standard>
Operation
<ASBOperation> Data Type

Object

Operation where the label shows.

 

Use instruction
(Label_UseInstruction)

<Basic><Standard>
UseInstruction
<ASBUseInstruction> Data Type

Object

Use instruction where the label shows.

 

Overwrite calendar
(Label_OCalendar)

<Basic><Standard>

Object

The overwrite calendar that is shown by this label object.

 

Row content
(Label_RowContent)

<Basic><Standard>

Enum

Specify the type of display content the label should be shown for.


ValueNameDescription
ResGanttAllOperResource gantt chart (Display all operations)Show this label only on Resource gantt chart (Display all operations) row.
ResGanttAccurateResQtyResource gantt chart (Accurate resource quantity)Show this label only on Resource gantt chart (Accurate resource quantity) row.
ResLoadRatioLoad ratio graphShow this label only on Load ratio graph row.
ResLoadAbsoluteLoad amount graphShow this label only on Load amount graph row.
ResGanttResWorkingPatternWorking patternShow this label only on Working pattern row.
OrderGanttOrder/Operation gantt chartShow this label only on Order/Operation gantt chart row.
ItemInventoryInventory graphShow this label only on Inventory graph row.
ItemProductionProduction graphShow this label only on Production graph row.
ItemConsumptionConsumption graphShow this label only on Consumption graph row.
ItemShippingShipping graphShow this label only on Shipping graph row.
ItemReceivingReceiving graphShow this label only on Receiving graph row.
ItemMfgOrderLETAchievementManufacturing order due date achievement graphShow this label only on Manufacturing order due date achievement graph row.
ItemSalesOrderLETAchievementSales order due date achievement graphShow this label only on Sales order due date achievement graph row.
ItemProductionLeadTimeProduction lead time graphShow this label only on Production lead time graph row.

 

Time point
(Label_TimePoint)

<Basic><Standard>
TimePoint
<DATE> Data Type

Time

The time that the label points to. Only available when the owner is resource or item.

 

Time span
(Label_TimeSpan)

<Basic><Standard>
TimeSpan
<LONG> Data Type

Time span

The time span that the label points to. Only available when the owner is resource or item, and the shape is Arrow.

 

Time stamp
(Label_TimeStamp)

<Standard>
TimeStamp
<DATE> Data Type

Time

The time when the label was added.

Display settings

Font
(Label_Font)

<Basic><Standard>
Font
<ASVFont> Data Type

Font

Font of the label's string.

 

Back color
(Label_BackColor)

<Basic><Standard>
BackgroundColor
<LONG> Data Type

Color

Back color of the label.

 

Border color
(Label_BorderColor)

<Basic><Standard>
BorderColor
<LONG> Data Type

Color

Border color of the label.

 

Text color
(Label_TextColor)

<Basic><Standard>
TextColor
<LONG> Data Type

Color

Text color of the label

 

Coordinate X
(Label_RelXRatio)

<Standard>
OwnerPointXRatio
<double> Data Type

Float

Coordinate X that the label points to. Only available when the owner is order, operation or use instruction. Please set a value between 0 and 1. 0 will be the start time, while 1 will be the end time.

 

Coordinate Y
(Label_RelYRatio)

<Standard>
OwnerPointYRatio
<double> Data Type

Float

Coordinate Y that the label points to. Please set a value between 0 and 1. 0 will be the top of the bar, while 1 will be the bottom.

 

Rectangle coordinate X
(Label_RectRelX)

<Standard>
RectLeftFromOwnerPoint
<double> Data Type

Float

Coordinate X of the label's rectangle's top left point. The unit is pixel.

 

Rectangle coordinate Y
(Label_RectRelY)

<Standard>
RectTopFromOwnerPoint
<double> Data Type

Float

Coordinate Y of the label's rectangle's top left point. The unit is pixel.

 

Display order
(Label_Z)

<Basic><Standard>
DisplayOrder
<LONG> Data Type

Integer

Display order of the label. The label will be shown in front if it has a bigger display order. It will be behind of bars if the display order is a minus value.

 

Rectangle height
(Label_Height)

<Standard>
Height
<double> Data Type

Float

Height of the label's rectangle. The unit is pixel.

 

Rectangle width
(Label_Width)

<Standard>
Width
<double> Data Type

Float

Width of the label's rectangle.

 

Arrow depth ratio
(Label_ArrowDepthRatio)

<Standard>
ArrowDepthRatio
<double> Data Type

Float

Depth ratio of the arrow label.

 

Arrow height ratio
(Label_ArrowStemHeightRatio)

<Standard>
ArrowStemHeightRatio
<double> Data Type

Float

Height ratio of the arrow label.

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.

All Properties

Resource code
(Label_ResourceCode)

<RO>
ResourceCode
<BSTR> Data Type

WBSRef

Code of resource where the label shows.

 

Item code
(Label_ItemCode)

<RO>
ItemCode
<BSTR> Data Type

WBSRef

Code of item where the label shows.

 

Order code
(Label_OrderCode)

<RO>
OrderCode
<BSTR> Data Type

WBSRef

Code of order where the label shows.

 

Operation code
(Label_OperationCode)

<RO>
OperationCode
<BSTR> Data Type

WBSRef

Code of operation where the label shows.

 

Task type
(Label_TaskType)

<RO>

Enum

Type of task where the label shows.


ValueNameDescription
O  
S  
P  
E  
T  
R  
C  
L  

 

Use instruction code(For DBIO)
(Label_UseInstructionIOCode)

<RO>

String

Code of use instruction where the label show (For DBIO).

 

Use instruction code
(Label_UseInstructionCode)

<RO>
UseInstructionCode
<BSTR> Data Type

WBSRef

Code of use instruction where the label show.

 

Overwrite calendar code
(Label_OCalendarCode)

<RO>

WBSRef

Code of the overwrite calendar that is shown by this label object.

 

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].

 
 
GetAsObject
<ASOObject> Data Type
<Method>

 

Obtains property value as object.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to obtain.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsObject
<VOID> Data Type
<Method>

 

Sets properties as object.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsInteger
<ASOObject> Data Type
<Method>

 

Obtains properties as integer.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsExpression
<ASOObject> Data Type
<Method>

 

Obtains properties as expression.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsTime
<ASOObject> Data Type
<Method>

 

Obtains properties as time.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsTimeSpan
<ASOObject> Data Type
<Method>

 

Obtains properties as time span.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsDouble
<ASOObject> Data Type
<Method>

 

Obtains properties as float.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsBool
<ASOObject> Data Type
<Method>

 

Obtains properties as boolean.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsEnum
<ASOObject> Data Type
<Method>

 

Obtains properties as enum.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsInteger
<VOID> Data Type
<Method>

 

Sets properties as integer.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsExpression
<VOID> Data Type
<Method>

 

Sets properties as expression.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsTime
<VOID> Data Type
<Method>

 

Sets properties as time.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsTimeSpan
<VOID> Data Type
<Method>

 

Sets properties as time span.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsDouble
<VOID> Data Type
<Method>

 

Sets properties as float.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsBool
<VOID> Data Type
<Method>

 

Sets properties as boolean.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsEnum
<VOID> Data Type
<Method>

 

Sets properties as enum.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.


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

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

See Also



HelpNo.:C218

© Since 2019 Asprova Corporation, All rights reserved.