Sigma
SigmaScript Self objekt
Avancerede emner > SigmaScript > SigmaScript funktioner og objekter > SigmaScript Self objekt

Glossary Item Box

Oversigt over SigmaScript funktioner, der anvendes til at hente og gemme værdier for en komponent.

 

Bemærk at hvor der er tale om Get* funktioner (f.eks. GetCostPrice), skal man kalde enten GetCostPriceAsString() eller GetCostPriceAsFloat(), alt efter hvilken sammenhæng man anvender funktionen.

 

Funktion Beskrivelse Eksempel

GetCategoryAsString() / GetCategoryAsFloat()
SetCategory(Text)

Kategori feltet  

GetCompareTotalPriceAsString() / GetCompareTotalPriceAsFloat()
SetCompareTotalPrice(Value)

   

GetCompareUnitPriceAsString() / GetCompareUnitPriceAsFloat()
SetCompareUnitPrice(Value)

   

GetCostPriceAsString() / GetCostPriceAsFloat()
SetCostPrice(Value)

Ureguleret kostpris. Hvis du skal bruge den samlede kostpris, skal du bruge GetRegCostPrice()  

GetCurrencyAsString() / GetCurrencyAsFloat()
SetCurrency(Text)

Valuta  

GetCustomFieldValue()
SetCustomFieldValue()

Adgang til ekstra felter for komponenten.

Følgende eksempel viser hvorledes et ekstra felt oprettes samt tildeles en værdi.

Execution script:

if not Project.HasCustomField("Account") then
    Project.CreateCustomField("Account", "Account number", "Description of account number field");
Self.SetCustomFieldValue("Account", "123456");
Self.SetNumber(Self.GetCustomFieldValue("Account"));

Bemærk, at det ikke er nødvendigt at kalde "Project.HasCustomField()", idet "Project.CreateCustomField()" ikke gør noget, hvis feltet findes i forvejen.

GetIncomeAsString() / GetIncomeAsFloat()
SetIncome(Value)

Dækningsbidrag  

GetItemPriceAsString() / GetItemPriceAsFloat()
SetItemPrice()

Samlet enhedspris  

GetKeywordsAsString() / GetKeywordsAsFloat()
SetKeywords(Text)

Komma-adskilt liste af stikord tilknyttet komponenten.  

GetLegalCostAsString() / GetLegalCostAsFloat()
SetLegalCost(Value)

   

GetLegalCostPercentageAsString() / GetLegalCostPercentageAsFloat()
SetLegalCostPercentage(Value)

   

GetNoteAsString() / GetNoteAsFloat()
SetNote(Text)

Note feltet  

GetNowValueAsString() / GetNowValueAsFloat()
SetNowValue(Value)

Claims: Ny-værdi  

GetNowValuePercentageAsString() / GetNowValuePercentageAsFloat()
SetNowValuePercentage(Value)

   

GetNumberAsString() / GetNumberAsFloat()
SetNumber(Text)

Nummer feltet  
GetParentClassName()

Returnerer "ClassName" for ovenliggende komponent. Bruges f.eks. til at angive at en komponent er en bygningsdel.

 
GetParentTotalQuantity() Returnerer samlet mængde for den ovenliggende komponent

Execution script:

q := self.GetParentTotalQuantity();
self.SetText("Total mængde=" + q);

GetPositionAsString()

Returnerer positionsnummer for pågældende komponent  

GetProductionRateAsString() / GetProductionRateAsFloat()
SetProductionRate(Value)

Produktions rate  

GetProductionUnitAsString() / GetProductionUnitAsFloat()
SetProductionUnit(Text)

Produktions enhed  

GetProductionUnitPriceAsString() / GetProductionUnitPriceAsFloat()
SetProductionUnitPrice(Value)

Produktion enhedspris  

GetProfitAsString() / GetProfitAsFloat()
SetProfit(Value)

Samlet DG  

GetQuantityAsString() / GetQuantityAsFloat()
SetQuantity(Value)

Mængde
quantity := self.GetQuantityAsFloat();

GetQuantityMinAsString() / GetQuantityMinAsFloat()
GetQuantityMaxAsString() / GetQuantityMaxAsFloat()
GetQuantityTypAsString() / GetQuantityTypAsFloat()

SetQuantityMin(Value)
SetQuantityMax(Value)
SetQuantityTyp(Value)

Angivelse af mængde ved successiv kalkulation  

GetRegCostPriceAsString() / GetRegCostPriceAsFloat()
SetRegCostPrice(Value)

Samlet kostpris, dvs. inkl. regulering, produktionsrate og valuta
totalCost := Self.GetRegCostPriceAsString();
Self.SetText("RegCP (Samlet KP)=" + totalCost);

GetRegulationAsString() / GetRegulationAsFloat()
SetRegulation(Value)

Regulering  

GetRemainAsString() / GetRemainAsFloat()
SetRemain(Value)

   

GetRemainPercentageAsString() / GetRemainPercentageAsFloat()
SetRemainPercentage(Value)

   

GetTextAsString() / GetTextAsFloat()
SetText(Text)

Tekst  

GetUnitPriceAsString() / GetUnitPriceAsFloat()
SetUnitPrice(Value)

Enhedspris  

GetUnitPriceMinAsString() / GetUnitPriceMinAsFloat()
GetUnitPriceMaxAsString() / GetUnitPriceMaxAsFloat()
GetUnitPriceTypAsString() / GetUnitPriceTypAsFloat()

SetUnitPriceMin(Value)
SetUnitPriceMax(Value)
SetUnitPriceTyp(Value)

Angivelse af enhedspris ved successiv kalkulation  
GetUnitsAsString() / GetUnitsAsFloat()
SetUnits(Text)
Enhed  
SetKeyFigure() Giver mulighed for at oprette et "komponent nøgletal", dvs. et nøgletalsudtryk som vises i den blå bjælke for den pågældende komponent
Self.SetKeyFigure("Pris pr. " + enh + " (i alt " + mngde + " " + enh + ")", "kostpris() / " + mngde);
HasImage() Angiver om komponenten har specificeret et billede. 0 for nej og 1 for ja.  
GetClassName()
SetClassName(Value)
Komponentens klassenavn
name := Self.GetClassName();
Self.SetClassName("type1");
GetClassPattern()
SetClassPattern(Value)
Komponentens regulære udtryk for komponenter som den kan indsættes under
pattern := GetText("Pattern:", Self.GetClassPattern());
Self.SetClassPattern(pattern);
GetClassNegatedPattern()
SetClassNegatedPattern(Value)
Komponentens regulære udtryk for komponenter som den ikke kan indsættes under
negatedPattern := GetText("Negated Pattern:", Self.GetClassNegatedPattern());
Self.SetClassNegatedPattern(negatedPattern);
 

©2011. All Rights Reserved.