Syntax
Public Function TransferSymbol (SymbolID As Integer, OldParentID As Integer, NewParentID As Integer) As SymbolSettingsEnum
Description
This function is used to transfer a symbol or a group of symbols form a group to another. After TransferSymbol method executes, the TransferSymbolResultReceived event fires.
Parameters
Parameter |
Description |
SymbolID |
The symbol identifier which is required to be transferred. Value of type is Integer. |
OldParentID |
The old parent identifier which is required to transfer symbol from. Value of type is String. 0: Means the Root. |
NewParentID |
The new parent identifier which is required to transfer the symbol to. Value of type is String. 0: Means the Root. |
Return value
Returns value of type SymbolSettingsEnum. If the request was sent to the server successfully it will return SuccessSymbolSettingResult.
Sample
Public WithEvents BOAPI as new CVertexFXBOAPI
Private Sub TransferSymbol _Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles TransferSymbol.Click
Dim result As SymbolSettingsEnum
Dim I As Integer
Dim ParentID As String
Dim Symbol As COSymbol
symbol= BOAPI.SymbolByID(6)
If not symbol is Nothing then
ParentID = Cstr(Symbol.ParentID)
End if
result = BOAPI.TransferSymbol (6, ParentID,0)
MsgBox("result " & result)
End Sub
See Also
VertexFX Backoffice API Index
Last Modified: 04 January 2017 04:30 PM
|