Building Plugins for Cytostudio™

 

  • One of the key elements of Cytostudio™ is the ability to extend it via plugins.
  • Building plugins for Cytostudio™ is easy.
  • Mini-App plugins can be written in JavaScript or Visual Basic.
  • Weather you want to automate your research procedures or looking for a custom interface for your solution, Cytostudio™ got your back !

 

Plugin Modes

 

  • Command Mode – Script runs only once. Useful for file generators or filters.
  • Iterative Mode – An iterative script execution. Required in order to build a Graphical User Interface (GUI). The Loop function is called in each iteration.

Message(message_box_text, message_box_caption)

 

  • Message Box is useful to display information or to alert the user.
  • message_box_text – The text message to display.
  • message_box_caption – The message box title.
  • Return value – 0.

CreateWindow(window_title, x, y, width, height)

 

  • Creates a graphical window for the plugin.
  • window_title – The window title.
  • x- The horizontal position of the left corner (in pixels).
  • y – The vertical position of the left corner (in pixels).
  • width – Window width (in pixels).
  • height – Window height (in pixels).
  • Return value – The window handle.

CreateButton(window_handle, button_caption, x, y, width, height)

 

  • Creates a button on the selected window.
  • window_handle – A window handle received from the CreateWindow procedure.
  • button_caption – The button’s inner text.
  • x- The horizontal position of the left corner (in pixels).
  • y – The vertical position of the left corner (in pixels).
  • width – Button width (in pixels).
  • height – Button height (in pixels).
  • Return value – The button handle.

IsButtonClicked(button_handle)

 

  • Checks whether the button was pressed during program execution.
  • button_handle – A button handle received from the CreateButton procedure.

CreateEditLine(window_handle, edit_line_initial_text, x, y, width, height)

 

  • Creates an edit line (a text box) to collect user input, on the selected window.
  • window_handle – A window handle received from the CreateWindow procedure.
  • edit_line_initial_text – The initial edit line inner text.
  • x- The horizontal position of the left corner (in pixels).
  • y – The vertical position of the left corner (in pixels).
  • width – Edit line width (in pixels).
  • height – Edit line height (in pixels).
  • Return value – The edit line handle.

CreateLabel(window_handle, label_initial_text, x, y, width, height)

 

  • Creates a text label in order to present user input or other properties, on the selected window.
  • window_handle – A window handle received from the CreateWindow procedure.
  • label_initial_text – The initial label inner text.
  • x- The horizontal position of the left corner (in pixels).
  • y – The vertical position of the left corner (in pixels).
  • width – Label width (in pixels).
  • height – Label height (in pixels).
  • Return value – The label handle.

CreateTextArea(window_handle, text_area_initial_text, x, y, width, height)

 

  • Creates a text area in order to present user input, output, or other properties, on the selected window.
  • window_handle – A window handle received from the CreateWindow procedure.
  • text_area_initial_text – The initial text area inner text.
  • x- The horizontal position of the left corner (in pixels).
  • y – The vertical position of the left corner (in pixels).
  • width – Text area width (in pixels).
  • height – Text area height (in pixels).
  • Return value – The text area handle.