Knowledgebase
6Downloads 2069Technical Support 90Release Notes 36Sales 3Accounting
Knowledgebase : Technical Support > API > BackEnd API's/VBL > Backoffice API > Properties
OrderRefHitBidPrice
SYNTAX  ReadOnly Property OrderRefHitBidPrice (OrderID As Integer) As Double DESCRIPTION This property is used to display the hit bid price for the reference symbol of the given order number. Parameters Parameter Description  OrderID Ord...
GetSelectedAccount
SYNTAX  ReadOnly Property Get GetSelectedAccount() As COAccount DESCRIPTION This property is used to return an object of type COAccount for the account that had been selected before. Parameters No parameter  RETURN VALUE Return object of type COAcc...
DealerUsernameByIndex
SYNTAX  ReadOnly Property DealerUsernameByIndex(ByRef Index As Integer) As String DESCRIPTION This property is used to get the dealer's username by giving the index of the dealer. Parameters Parameter Description  Index Dealer location a...
DealerDescriptionByIndex
SYNTAX  ReadOnly Property DealerDescriptionByIndex(ByRef Index As Integer) As String DESCRIPTION This property is used to get the dealer's description by giving the Index of the dealer. Parameters Parameter Description  Index Dealer Inde...
DealersCount
SYNTAX  ReadOnly Property DealersCount() As Integer DESCRIPTION This property is used to get dealers count that belongs to login dealer. Parameters No Parameters. RETURN VALUE Returns dealers number as an Integer value. SAMPLE  Public WithEvents ...
DealerIDByUsername
SYNTAX  ReadOnly Property DealerIDByUsername(ByRef Username As String) As Integer DESCRIPTION This property is used to get the dealer's  ID by giving his username. Parameters Parameter Description  Username Dealer username to get its ID,...
Username
SYNTAX  Property Get Username() As String DESCRIPTION This property is used to get value of the client username as string. Parameters No parameters. RETURN VALUE Returns the value of the client username as value of type String SAMPLE  Public With...
ParentID
SYNTAX  Property Get ParentID() As Integer DESCRIPTION This property is used to get value of parent ID as integer. Parameters No parameters. RETURN VALUE Returns the value of the parent ID as Integer type SAMPLE  Public WithEvents BOAPI As CVerte...
MarginAccount
SYNTAX  Property Get MarginAccount () As Boolean DESCRIPTION This property returns a boolean value that indicates if the account is a margin account or not. Parameters No parameters. RETURN VALUE Returns true if the account is a margin account ,Oth...
AccountType
SYNTAX  Property Get AccountType () As AccountTypeEnum DESCRIPTION This property is used to return the type for account which releated to login delear. Parameters No parameters. RETURN VALUE Return the value of type AccountTypeEnum [http://www.hybr...
Locked
SYNTAX  Property Get Locked () As Boolean DESCRIPTION This property used to get value for the client as a Boolean that indicated if the client is locked or not. Parameters No parameters. RETURN VALUE Returns true if client is locked ,Otherwise it w...
DontLiquidate
SYNTAX  Property Get DontLiquidate () As Boolean DESCRIPTION This property used to get value for the client as a Boolean that indicated if the client is  not liquidate client or not. Parameters No parameters. RETURN VALUE Returns true if client is ...
UnitByIndex
SYNTAX  Readonly Property UnitByIndex (ByRef Index As Integer) As VertexFXBOAPI.COAmountUnit DESCRIPTION This property is used to return an object of COAmountUnit [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4985] by p...
UnitsCount
SYNTAX  Readonly Property UnitsCount () As Integer DESCRIPTION This property is used to return counts of symbol units. PARAMETERS No Parameters. RETURN VALUE Returns the count of symbol units, value of type is Integer. SAMPLE  Public WithEvents B...
ChatOn
SYNTAX  Readonly Property ChatOn () As Boolean DESCRIPTION This property is used to determine if the chat screen is on or off. PARAMETERS No Parameters. RETURN VALUE Returns true if the the chatting screen it on, otherwise false. SAMPLE  Public W...
OrdersCount
SYNTAX  Readonly Property OrderCount () As Integer DESCRIPTION This property is used to return total counts of the orders . PARAMETERS No Parameters. RETURN VALUE Returns as integer value for the total counts of the orders. SAMPLE  Public WithEve...
OrderByIndex
SYNTAX  Readonly Property OrderByIndex (ByRef Index As Integer) As VertexFXBOAPI.COOrder DESCRIPTION This property is used to return an object of type COOrder [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4980] using th...
OrderByID
SYNTAX  Readonly Property OrderByID (ByRef OrderId As Integer) As VertexFXBOAPI.COOrder DESCRIPTION This property is used to return an object of type COOrder [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4980] using the...
FirstWhiteLabel
SYNTAX  Readonly Property FirstWhiteLabel As Integer DESCRIPTION This property is used to retrieve the ID of white label which login dealer is belong to as value of type is Integer. PARAMETERS No Parameters. SAMPLE  Public WithEvents BOAPI As CVert...
ChatOrdersByIndex
SYNTAX  Readonly Property ChatOrderByIndex(ByRef Index As Integer) As COChatOrder DESCRIPTION This property is used to get COChatOrder [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4982] object for the giving orders ind...
ChatOrdersCount
SYNTAX  Readonly Property ChatOrdersCount As Integer DESCRIPTION This property is used to get the total number of orders that exist on the chatting screen. PARAMETERS No parameters. SAMPLE  Public WithEvents BOAPI As CVertexFXBOAPI Private Sub Cha...
Version
SYNTAX  Readonly Property Version As Short DESCRIPTION This property is used to retrieve the version number for the Backoffice API as a value of type short. PARAMETERS No parameters. SAMPLE  Public WithEvents BOAPI As CVertexFXBOAPI Private Sub Ve...
ServerGMTOffset
SYNTAX  Readonly Property ServerGMTOffset As Double DESCRIPTION This property is used to retrieve the server GMT offset as a value of type is Double. PARAMETERS No parameters. SAMPLE  Public WithEvents BOAPI As CVertexFXBOAPI Private Sub ServerGMT...
Release
SYNTAX  Readonly Property Release As Short DESCRIPTION This property is used to retrieve the release number for the backoffice API as a value of type short. PARAMETERS No parameters. SAMPLE  Public WithEvents BOAPI As CVertexFXBOAPI Private Sub Re...
Patch
SYNTAX  Readonly Property Patch As Short DESCRIPTION This property to retrieve the patch number for the Backoffice API as a value of type short. PARAMETERS No parameters. SAMPLE  Public WithEvents BOAPI As CVertexFXBOAPI Private Sub Patch_Click(By...
OnlineSessions
SYNTAX  Readonly Property OnlineSessions As VBA.Collection DESCRIPTION This property is used to retrieve the collection of type online sessions [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4126] for each connected sess...
GMTOffset
SYNTAX  Readonly Property GMTOffset As Double DESCRIPTION This property is used to retrieve the GMT offset as a value of type is double. PARAMETERS No parameters. SAMPLE  Public WithEvents BOAPI As CVertexFXBOAPI Private Sub GMT_Click(ByVal sender...
ClientsCount
SYNTAX  Readonly Property ClientsCount As Integer. DESCRIPTION This property used to get a total number of the clients which related to login delear . PARAMETERS No parameters. RETURN VALUE  Returns client count as value of type Integer SAMPLE  P...
ClientByIndex
SYNTAX  Readonly Property ClientByIndex(ByRef Index As Integer) As VertexFXBOAPI.COClient DESCRIPTION This property is used to get the client information as an object of type COClient [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Ar...
ClientByID
SYNTAX  Readonly Property ClientByID(ByRef ID As Integer) As VertexFXBOAPI.COClient DESCRIPTION This property is used to return COClient [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/4981] object for the given client ID...
AccountsCount
SYNTAX  Readonly Property AccountsCount(ByRef ClientID As Integer)As Integer DESCRIPTION This property used to get the total number of accounts that allocated under specific client. PARAMETERS Part Description ClientID Associated client ...
AccountByIndex
SYNTAX Readonly Property AccountByIndex(ByRef ClientID As Integer,ByRef Index As Integer)As COAccount DESCRIPTION This property is used to get an COAccount [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2151] object  by ...
AccountByID
SYNTAX  Readonly Property AccountByID(ByRef AccountID As Integer)As VertexFXBOAPI.COAccount DESCRIPTION This property is used to get the COAccount [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2151] object by the giving...
GMTOffset
SYNTAX ReadOnly Property GMTOffset() As Double DESCRIPTION This property takes no parameters and returns the GMTOffset value. PARAMETERS No parameters. SAMPLE  Private Sub GMTOffset_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) ...
DealerUsernameByID
SYNTAX  Readonly Property DealerUsernameByID(ByRef DealerID As Integer) As String DESCRIPTION This property is used to get dealer's username by giving his ID. PARAMETERS Part Description DealerID Associated dealer number to get his name,...
isChild
SYNTAX  Readonly Property isChild(ByRef ClientID As Integer,ByRef ParentID As Integer)As Boolean DESCRIPTION This property is used to check if the given client is child of the given parent identifier or not. PARAMETERS Part Description Clie...
ClientID
SYNTAX  Readonly Property ClientID(ClientUsername As String) As Integer DESCRIPTION This property is used to get the client identifier by his username. PARAMETERS Part Description ClientUsername  Username of the client  to get an ID for ...
Account
SYNTAX  Readonly Property Account(AccountID As Integer) As VertexFXBOAPI.COAccount DESCRIPTION Used to get the COAccount [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2151] object by giving the specific account number. ...
RootID
SYNTAX  Readonly Property RootID As Integer DESCRIPTION This property is used to get the ID of the main accounts tree node. PARAMETERS No parameters. REMARKS   You need this property when you need the ID of the main accounts tree node for the conne...
MoneyTrans
SYNTAX  Readonly Property MoneyTrans As VertexFXBOAPI.CMoneyTransI DESCRIPTION This property used to do money transactions operations for a specific account. MEMBERS Members Description Adjustment To make an adjustment on money that belo...
UserHasPriv
SYNTAX  Readonly Property UserHasPriv(ByRef Privilege As VertexFXBOAPI.PrivsEnum) As Boolean DESCRIPTION This property is used to know if the client has a privileges for the given privilage type or not. PARAMETERS Part Description Privilege...
SymbolsCount
SYNTAX  Readonly Property SymbolsCount As Integer DESCRIPTION This property is used to display the total number of the symbols. PARAMETERS No parameters. RETURN VALUE  Returns symbol count as value of type Integer SAMPLE  Public WithEvents BOAPI ...
SymbolByName
SYNTAX  Readonly Property SymbolByName(Name As String) As VertexFXBOAPI.COSymbol DESCRIPTION This property is used to get COsymbol [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2147] object by the symbol name PARAMETER...
SymbolByIndex
SYNTAX  ReadOnly property SymbolByIndex (Index As Long, Optional ShowUnused As Boolean = False) As COSymbol DESCRIPTION This property is used to get the symbol information as the object of type COSymbol [http://www.hybrid-solutions.com/support/index.ph...
SymbolByID
SYNTAX  ReadOnly property SymbolByID (ID As Long, Optional ShowUnused As Boolean = False) As COSymbol DESCRIPTION This property is used to get a symbol information as the object of type COSymbol [http://www.hybrid-solutions.com/support/index.php?/Knowl...
ServerPort
SYNTAX  Readonly Property ServerPort As Integer DESCRIPTION This property used to retrieve the previous used IP port with the SetLoginInfo [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/1978] method. PARAMETERS No para...
ServerIP
SYNTAX  Readonly property ServerIP As String DESCRIPTION This property used to retrieve the previous used IP Address with the SetLoginInfo [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/1978] method. PARAMETERS No para...
OrderRefHitAskPrice
SYNTAX  Readonly Property OrderRefHitAskPrice(OrderId As Integer) As Double DESCRIPTION This property is used to display the hit ask price for the reference symbol of the given order number. PARAMETERS Part Description OrderID Order numb...
LoginUsername
SYNTAX  Readonly Property LoginUsername As String DESCRIPTION This property used to retrieve the previous used Username with the SetLoginInfo [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/1978] method. PARAMETERS No p...
LoginPassword
SYNTAX  Readonly Property LoginPassword As String DESCRIPTION This property used to retrieve the previous used Password with the SetLoginInfo [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/1978] method. PARAMETERS No p...
OrderSymbol
SYNTAX  Readonly Property OrderSymbol(OrderID As Integer) As VertexFXBOAPI.COSymbol DESCRIPTION This property use to return the COSymbol [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2147] object by giving order number....
OrderLots
SYNTAX  Readonly Property OrderLots(OrderID As Integer) As Double DESCRIPTION This property used to know the amount of lots for a specific order. PARAMETERS Part Description OrderID Associated order number you want to know its lots amoun...
OrderOpenPrice
SYNTAX  Readonly Property OrderOpenPrice(OrderID As Integer)As Double DESCRIPTION This property use to know the order open price by giving order number. PARAMETERS Part Description OrderID Associated order number to get open price for  ,...
OrderHitPrice
SYNTAX  Readonly Property OrderHitPrice(OrderID As Integer)As Double DESCRIPTION This property use to know the executed order price by giving order number. PARAMETERS Parameters Description OrderID Associated order number to know hit pri...
OrderBuySell
SYNTAX  Readonly Property OrderBuySell(OrderID As Integer) As VertexGeneral.OperationTypeEnum DESCRIPTION This property used to recognize if your order type is Buy or Sell or BuyStop or SellStop by giving order number. PARAMETERS Parameters Des...
OpenPositionsCount
SYNTAX  Readonly Property OpenPositionsCount As Integer DESCRIPTION This property used to return the total number of all open positions on trade list . PARAMETERS No parameters. REMARKS   In the case you want to know how many open positions you hav...
OpenPositionByTicket
SYNTAX  Readonly Property OpenPositionByTicket(ByRef Ticket As Integer) As VertexFXBOAPI.COOpenPosition DESCRIPTION This property used to get COOpenPosition [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2154] object by ...
OpenPositionByIndex
SYNTAX  Readonly Property OpenPositionByIndex(ByRef Index As Integer) As VertexFXBOAPI.COOpenPosition DESCRIPTION This property used to get COOpenPosition [http://www.hybrid-solutions.com/support/index.php?/Knowledgebase/Article/View/2154] object by gi...
LogedOn
SYNTAX  Readonly Property LogedOn As Boolean DESCRIPTION This property used to know if the session connected or not . PARAMETERS No parameters. RETURN VALUE  Return value of boolean type to which indicate the session stauts. REMARKS   If this pro...
ChatStatus
SYNTAX  Readonly Property ChatStatus As Boolean DESCRIPTION Used to know if the chatting is On or Off at the moment. PARAMETERS No parameters. RETURN VALUE  Returns true if the chat status is on , otherwise it will return false.  SAMPLE  Public W...
Help Desk Software by Hybrid Solutions