TradeMUX SDK Documentation  1.0
TradeMUX SDK Documentation
bool ObjectSetInteger ( long  chart_id,
string  object_name,
int  prop_id,
long  long_var 
)

Sets the value of the corresponding object property. The object property must be of the datetime, int, color, bool or char type

Parameters
chart_idChart identifier
nameObject name
prop_idID of the object property. The value can be one of the following values:
OBJPROP_COLORColorcolor
OBJPROP_STYLEStyleENUM_LINE_STYLE:
DRAW_LINEDrawing line
DRAW_SECTIONDrawing sections
DRAW_HISTOGRAMDrawing histogram
DRAW_ARROWDrawing arrows (symbols)
DRAW_ZIGZAGDrawing sections between even and odd indicator buffers, 2 buffers of values
DRAW_NONENo drawing
OBJPROP_WIDTHLine thicknessint
OBJPROP_BACKObject in the backgroundbool
OBJPROP_ZORDERPriority of a graphical object for receiving events of clicking on a chart (CHARTEVENT_CLICK). The default zero value is set when creating an object; the priority can be increased if necessary. When objects are placed one atop another, only one of them with the highest priority will receive the CHARTEVENT_CLICK event.long
OBJPROP_HIDDENProhibit showing of the name of a graphical object in the list of objects from the terminal menu "Charts" - "Objects" - "List of objects". The true value allows to hide an object from the list. By default, true is set to the objects that display calendar events, trading history and to the objects created from programs. To see such graphical objects and access their properties, click on the "All" button in the "List of objects" window.bool
OBJPROP_SELECTEDObject is selected bool
OBJPROP_READONLYAbility to edit text in the Edit objectbool
OBJPROP_TYPEObject typeENUM_OBJECT r/o:
OBJ_VLINEVertical Line
OBJ_HLINEHorizontal Line
OBJ_TRENDTrend Line
OBJ_TRENDBYANGLETrend Line By Angle
OBJ_CYCLESCycle Lines
OBJ_CHANNELEquidistant Channel
OBJ_STDDEVCHANNELStandard Deviation Channel
OBJ_REGRESSIONLinear Regression Channel
OBJ_PITCHFORKAndrews’ Pitchfork
OBJ_GANNLINEGann Line
OBJ_GANNFAN Gann Fan
OBJ_GANNGRIDGann Grid
OBJ_FIBOFibonacci Retracement
OBJ_FIBOTIMESFibonacci Time Zones
OBJ_FIBOFANFibonacci Fan
OBJ_FIBOARCFibonacci Arcs
OBJ_FIBOCHANNELFibonacci Channel
OBJ_EXPANSIONFibonacci Expansion
OBJ_RECTANGLERectangle
OBJ_TRIANGLETriangle
OBJ_ELLIPSEEllipse
OBJ_ARROW_THUMB_UPThumbs Up
OBJ_ARROW_THUMB_DOWNThumbs Down
OBJ_ARROW_UPArrow Up
OBJ_ARROW_DOWNArrow Down
OBJ_ARROW_STOPStop Sign
OBJ_ARROW_CHECKCheck Sign
OBJ_ARROW_LEFT_PRICELeft Price Label
OBJ_ARROW_RIGHT_PRICERight Price Label
OBJ_ARROW_BUYBuy Sign
OBJ_ARROW_SELLSell Sign
OBJ_ARROWArrow
OBJ_TEXTText
OBJ_LABELLabel
OBJ_BUTTONButton
OBJ_BITMAPBitmap
OBJ_BITMAP_LABELBitmap Label
OBJ_EDITEdit
OBJ_EVENTThe "Event" object corresponding to an event in the economic calendar
OBJ_RECTANGLE_LABEL The "Rectangle label" object for creating and designing the custom graphical interface.
OBJPROP_TIMETime coordinatedatetime modifier=number of anchor point
OBJPROP_SELECTABLEObject availabilitybool
OBJPROP_CREATETIMETime of object creationdatetime r/o
OBJPROP_LEVELSNumber of levelsint
OBJPROP_LEVELCOLORColor of the line-level color   modifier=level number
OBJPROP_LEVELSTYLEStyle of the line-level ENUM_LINE_STYLE modifier=level number:
STYLE_SOLIDThe pen is solid
STYLE_DASHThe pen is dashed
STYLE_DOTThe pen is dotted
STYLE_DASHDOTThe pen has alternating dashes and dots
STYLE_DASHDOTDOTThe pen has alternating dashes and double dots
OBJPROP_LEVELWIDTHThickness of the line-levelint modifier=level number
OBJPROP_ALIGNHorizontal text alignment in the "Edit" object (OBJ_EDIT) ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT
OBJPROP_FONTSIZEFont sizeint
OBJPROP_RAY_RIGHTRay goes to the right bool
OBJPROP_ELLIPSEShowing the full ellipse of the Fibonacci Arc object (OBJ_FIBOARC)bool
OBJPROP_ARROWCODEArrow code for the Arrow objectchar
OBJPROP_TIMEFRAMESVisibility of an object at timeframesset of flags flags
OBJPROP_ANCHORLocation of the anchor point of a graphical objectANCHOR_TOP,ANCHOR_BOTTOM (for OBJ_ARROW),ANCHOR_LEFT_UPPER,
ANCHOR_LEFT_UPPER, ANCHOR_LEFT, ANCHOR_LEFT_LOWER,ANCHOR_LOWER, ANCHOR_RIGHT_LOWER,
ANCHOR_RIGHT, ANCHOR_RIGHT_UPPER, ANCHOR_UPPER, ANCHOR_CENTER
(for OBJ_LABEL, OBJ_BITMAP_LABEL and OBJ_TEXT)
OBJPROP_XDISTANCEThe distance in pixels along the X axis from the binding corner (see note)int
OBJPROP_YDISTANCEThe distance in pixels along the Y axis from the binding corner (see note)int
OBJPROP_DRAWLINESDisplaying lines for marking the Elliott Wavebool
OBJPROP_STATEButton state (pressed / depressed)bool
OBJPROP_XSIZEThe object's width along the X axis in pixels. Specified for  OBJ_LABEL (read only), OBJ_BUTTON, OBJ_BITMAP, OBJ_BITMAP_LABEL, OBJ_EDIT, OBJ_RECTANGLE_LABEL objects.int
OBJPROP_YSIZEThe object's height along the Y axis in pixels. Specified for  OBJ_LABEL (read only), OBJ_BUTTON, OBJ_BITMAP, OBJ_BITMAP_LABEL, OBJ_EDIT, OBJ_RECTANGLE_LABEL objects.int
OBJPROP_XOFFSETThe X coordinate of the upper left corner of the rectangular visible area in the graphical objects "Bitmap Label" and "Bitmap" (OBJ_BITMAP_LABEL and OBJ_BITMAP). The value is set in pixels relative to the upper left corner of the original image.int
OBJPROP_YOFFSETThe Y coordinate of the upper left corner of the rectangular visible area in the graphical objects "Bitmap Label" and "Bitmap" (OBJ_BITMAP_LABEL and OBJ_BITMAP). The value is set in pixels relative to the upper left corner of the original image.int
OBJPROP_BGCOLORThe background color for  OBJ_EDIT, OBJ_BUTTON, OBJ_RECTANGLE_LABELcolor
OBJPROP_CORNERThe corner of the chart to link a graphical objectCORNER_LEFT_UPPER, CORNER_LEFT_LOWER, CORNER_RIGHT_LOWER, CORNER_RIGHT_UPPER
OBJPROP_BORDER_TYPEBorder type for the "Rectangle label" objectBORDER_FLAT, BORDER_RAISED, BORDER_SUNKEN
OBJPROP_BORDER_COLORBorder color for the OBJ_EDIT and OBJ_BUTTON objectscolor
long_varNew property value
Returns
True only if the command to change properties of a graphical object has been sent to a chart successfully. Otherwise it returns false. To read more about the error call GetLastError()