ComponentGroup – Aspire Only: Difference between revisions

From SDK
Jump to navigation Jump to search
(Created page with "Category:SDK right|50px|link=Aspire Only This object represents a group of Components. A ComponentGroup may contain ComponentGroups. ==Properties==...")
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:


==Properties==
==Properties==




===.GetCount===
===.GetCount===
'''Interaction:''' Read Only   
'''Interaction:''' Read Only   
 
'''Returns:''' (integer) the number of components in the group
'''Returns:''' (integer) the number of components in the group
 
 
 
 


===.Count===
===.Count===
'''Interaction:''' Read Only  
'''Interaction:''' Read Only  
 
'''Returns:''' (integer) the number of components in the group
'''Returns:''' (integer) the number of components in the group
 
 
 
 


===.IsEmpty===
===.IsEmpty===
'''Interaction:''' Read Only
'''Interaction:''' Read Only
 
'''Returns:''' (bool) true if the group is empty
'''Returns:''' (bool) true if the group is empty
 


==Methods==
==Methods==
Line 37: Line 22:


===:GetHead()===
===:GetHead()===
'''Returns:''' (the component at the head of the group, the component remains in the group
'''Returns:''' (the component at the head of the group, the component remains in the group
 


===:GetHeadPosition()===
===:GetHeadPosition()===
'''Returns:''' (POSITION) a variable to allow access to the head of the list of components in the group
'''Returns:''' (POSITION) a variable to allow access to the head of the list of components in the group
 


===:GetTailPosition()===
===:GetTailPosition()===
'''Returns:''' (POSITION) a variable to allow access to the tail of the list of components in the group
'''Returns:''' (POSITION) a variable to allow access to the tail of the list of components in the group
 


===:GetNext(POSITION pos)===
===:GetNext(POSITION pos)===
'''Returns:''' Both the component at the current position '''AND''' a new value for position pointing to the next item in the group (or nil if at end of group)
'''Returns:''' Both the component at the current position '''AND''' a new value for position pointing to the next item in the group (or nil if at end of group)
pos (POSTION) current position in group
pos (POSTION) current position in group
 


===:GetPrev(POSITION pos)===
===:GetPrev(POSITION pos)===
'''Returns:''' Both the component at the current position '''AND''' a new value for position pointing to the previous item in the group (or nil if at end of group)
'''Returns:''' Both the component at the current position '''AND''' a new value for position pointing to the previous item in the group (or nil if at end of group)
 
pos (POSTION) current position in group
pos (POSTION) current position in group
 


===:GetAt(POSITION pos)===
===:GetAt(POSITION pos)===
'''Returns:''' the component at the passed position
'''Returns:''' the component at the passed position
 
pos (POSTION) position in group
pos (POSTION) position in group


=DocumentVariableList=
=DocumentVariableList=
Line 71: Line 49:


==Methods==
==Methods==


===:DocumentVariableExists (string variable_name)===
===:DocumentVariableExists (string variable_name)===
'''Returns:''' (bool) true if a DocumentVariable with the passed name exists
'''Returns:''' (bool) true if a DocumentVariable with the passed name exists
 
  Variable_name (string) Name for variable  
::''Variable_name (string) Name for variable''




===:GetDocumentVariable (string variable_name)===
===:GetDocumentVariable (string variable_name)===
'''Returns:''' a DocumentVariable with the passed name if exists otherwise nil
'''Returns:''' a DocumentVariable with the passed name if exists otherwise nil
 
  Variable_name (string) Name for variable  
::''Variable_name (string) Name for variable''




===:SetDocumentVariable (string variable_name, double value)===
===:SetDocumentVariable (string variable_name, double value)===
Sets the DocumentVariable with the specified name to the passed value. It either creates a new variable if one with the passed name does not exist or updates the current one to the new value. Please see the documentation for IsInvalidDocumentVariableName as to what constitutes a valid variable name.
Sets the DocumentVariable with the specified name to the passed value. It either creates a new variable if one with the passed name does not exist or updates the current one to the new value. Please see the documentation for IsInvalidDocumentVariableName as to what constitutes a valid variable name.
::''Variable_name (string) Name for variable''
Variable_name (string) Name for variable
::''Value(double) value of the variable''
Value(double) value of the variable




===:DocumentVariable True(string variable_name)===
===:DocumentVariable True(string variable_name)===
'''Returns:''' (bool) true if a DocumentVariable with the passed name is deleted otherwise false. Please note DocumentVariables considered to be in use cannot be deleted.
'''Returns:''' (bool) true if a DocumentVariable with the passed name is deleted otherwise false. Please note DocumentVariables considered to be in use cannot be deleted.
::''Variable_name (string) Name for variable''
Variable_name (string) Name for variable






===:GetHeadPosition()===
===:GetHeadPosition()===
'''Returns:''' (POSITION) a variable to allow access to the head of the list of DocumentVariables in the list
'''Returns:''' (POSITION) a variable to allow access to the head of the list of DocumentVariables in the list






===:GetNext(POSITION pos)===
===:GetNext(POSITION pos)===
'''Returns:''' Both the DocumentVariable at the current position '''AND'''a new value for position pointing to the next item in the list (or nil if at end of list)
'''Returns:''' Both the DocumentVariable at the current position '''AND'''a new value for position pointing to the next item in the list (or nil if at end of list)
 
pos (POSTION) current position in group
::''pos (POSTION) current position in group''


=DocumentVariable=
=DocumentVariable=
Line 112: Line 86:


==Properties==
==Properties==


===.Name===
===.Name===
'''Interaction:''' Read Only
'''Interaction:''' Read Only
 
'''Returns:''' (string) the name of the DocumentVariable
'''Returns:''' (string) the name of the DocumentVariable
 
 
 
 


===.Value===
===.Value===
'''Interaction:''' Read Only
'''Interaction:''' Read Only
 
'''Returns:''' (double) the value of the DocumentVariable
'''Returns:''' (double) the value of the DocumentVariable
 


[[File:Back.jpg|right|50px|link=Aspire Only]]
[[File:Back.jpg|right|50px|link=Aspire Only]]
==References==
==References==
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]

Latest revision as of 17:56, 1 May 2024

Back.jpg

This object represents a group of Components. A ComponentGroup may contain ComponentGroups.

Properties

.GetCount

Interaction: Read Only 

Returns: (integer) the number of components in the group

.Count

Interaction: Read Only 

Returns: (integer) the number of components in the group

.IsEmpty

Interaction: Read Only 

Returns: (bool) true if the group is empty

Methods

:GetHead()

Returns: (the component at the head of the group, the component remains in the group

:GetHeadPosition()

Returns: (POSITION) a variable to allow access to the head of the list of components in the group

:GetTailPosition()

Returns: (POSITION) a variable to allow access to the tail of the list of components in the group

:GetNext(POSITION pos)

Returns: Both the component at the current position AND a new value for position pointing to the next item in the group (or nil if at end of group)
pos (POSTION) current position in group

:GetPrev(POSITION pos)

Returns: Both the component at the current position AND a new value for position pointing to the previous item in the group (or nil if at end of group)
pos (POSTION) current position in group

:GetAt(POSITION pos)

Returns: the component at the passed position
pos (POSTION) position in group

DocumentVariableList

This object is responsible for managing all the document variables associated with a Job. A reference to a DocumentVariableList is obtained via the DocumentVariables property of the VectricJob.

local document_variable_list = job.DocumentVariables

Methods

:DocumentVariableExists (string variable_name)

Returns: (bool) true if a DocumentVariable with the passed name exists
 Variable_name (string) Name for variable


:GetDocumentVariable (string variable_name)

Returns: a DocumentVariable with the passed name if exists otherwise nil
 Variable_name (string) Name for variable


:SetDocumentVariable (string variable_name, double value)

Sets the DocumentVariable with the specified name to the passed value. It either creates a new variable if one with the passed name does not exist or updates the current one to the new value. Please see the documentation for IsInvalidDocumentVariableName as to what constitutes a valid variable name. 

Variable_name (string) Name for variable
Value(double) value of the variable


:DocumentVariable True(string variable_name)

Returns: (bool) true if a DocumentVariable with the passed name is deleted otherwise false. Please note DocumentVariables considered to be in use cannot be deleted.
Variable_name (string) Name for variable


:GetHeadPosition()

Returns: (POSITION) a variable to allow access to the head of the list of DocumentVariables in the list


:GetNext(POSITION pos)

Returns: Both the DocumentVariable at the current position ANDa new value for position pointing to the next item in the list (or nil if at end of list)
pos (POSTION) current position in group

DocumentVariable

This object is a name of value pair that represents a Document Variable within a VectricJob.

Properties

.Name

Interaction: Read Only 

Returns: (string) the name of the DocumentVariable

.Value

Interaction: Read Only 

Returns: (double) the value of the DocumentVariable
Back.jpg

References

Please Note: The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at Vertric Developer Information

Retrieved from "https://jimandi.com/SDK/index.php?title=ComponentGroup_–_Aspire_Only&oldid=898"