BioCore  4.0.1
A .NET library & program for annotating, editing various microscopy imaging formats using Bioformats supported images. Including whole slide, pyramidal, and series.
All Classes Namespaces Functions Enumerations Properties
BioCore.App Class Reference

Static Public Member Functions

static void Initialize (bool requireImageJ=false)
 Initialize() is a function that initializes the BioImage Suite Web viewer. More...
 
static void Hide ()
 Hide() hides all the tools. More...
 
static ToolStripItem GetMenuItemFromPath (string s)
 
static ToolStripItem GetContextMenuItemFromPath (string s)
 
static void AddMenu (string menu)
 
static void AddContextMenu (string menu)
 
static List< ToolStripMenuItem > GetMenuItems ()
 Retrieves all the menu items from the main menu strip More...
 
static List< ToolStripMenuItem > GetContextItems ()
 
static ToolStripItem GetMenuItemFromPath (string s, Function f)
 
static ToolStripItem GetContextMenuItemFromPath (string s, Function f)
 
static void AddMenu (string menu, Function f)
 
static void AddContextMenu (string menu, Function f)
 
static void AddROI (string an)
 

Static Public Attributes

static ROIManager manager = null
 
static ChannelsTool channelsTool = null
 
static TabsView tabsView = null
 
static NodeView nodeView = null
 
static Scripting runner = null
 
static Recorder recorder = null
 
static Tools tools = null
 
static StackTools stackTools = null
 
static ImageView viewer = null
 
static Series seriesTool = null
 
static BioConsole console = null
 
static Library lib = null
 
static List< string > recent = new List<string>()
 

Properties

static BioImage Image [get]
 Gets the BioImage object for the selected image in the ImageView. If no image is selected, returns the image from the tabsView. More...
 
static List< ChannelChannels [get]
 
static List< ROIAnnotations [get]
 
static bool Initialized [get]
 

Detailed Description

Definition at line 5 of file App.cs.

Member Function Documentation

◆ AddContextMenu() [1/2]

static void BioCore.App.AddContextMenu ( string  menu)
static

It takes a string and a function and adds a context menu item to the context menu

Parameters
menuThe path to the menu item.
FunctionThe function that will be called when the menu item is clicked.

Definition at line 195 of file App.cs.

◆ AddContextMenu() [2/2]

static void BioCore.App.AddContextMenu ( string  menu,
Function  f 
)
static

It takes a string and a function and adds a context menu item to the context menu

Parameters
menuThe path to the menu item.
FunctionThe function that will be called when the menu item is clicked.

Definition at line 368 of file App.cs.

◆ AddMenu() [1/2]

static void BioCore.App.AddMenu ( string  menu)
static

It takes a string and a function and adds the function to the menu item specified by the string

Parameters
menuThe menu path to add the menu item to.
FunctionThe function that will be called when the menu item is clicked.

Definition at line 187 of file App.cs.

◆ AddMenu() [2/2]

static void BioCore.App.AddMenu ( string  menu,
Function  f 
)
static

It takes a string and a function and adds the function to the menu item specified by the string

Parameters
menuThe menu path to add the menu item to.
FunctionThe function that will be called when the menu item is clicked.

Definition at line 360 of file App.cs.

◆ AddROI()

static void BioCore.App.AddROI ( string  an)
static

It takes a string, converts it to a ROI, and adds it to the list of ROIs

Parameters
anthe string representation of the ROI

Definition at line 398 of file App.cs.

◆ GetContextItems()

static List< ToolStripMenuItem > BioCore.App.GetContextItems ( )
static

It takes a list of items, and for each item in the list, it adds that item to the list, and then adds all the items in that item's submenu to the list

Returns
A list of ToolStripMenuItems

Definition at line 237 of file App.cs.

◆ GetContextMenuItemFromPath() [1/2]

static ToolStripItem BioCore.App.GetContextMenuItemFromPath ( string  s)
static

It takes a string and a function, and adds the function to the context menu at the location specified by the string

Parameters
sThe path to the item.
Function
Returns
A ToolStripItem

Definition at line 135 of file App.cs.

◆ GetContextMenuItemFromPath() [2/2]

static ToolStripItem BioCore.App.GetContextMenuItemFromPath ( string  s,
Function  f 
)
static

It takes a string and a function, and adds the function to the context menu at the location specified by the string

Parameters
sThe path to the item.
Function
Returns
A ToolStripItem

Definition at line 308 of file App.cs.

◆ GetMenuItemFromPath() [1/2]

static ToolStripItem BioCore.App.GetMenuItemFromPath ( string  s)
static

It takes a string and a function, and adds the function to the menu item specified by the string

Parameters
sThe path to the menu item.
Function
Returns
A ToolStripItem

Definition at line 82 of file App.cs.

◆ GetMenuItemFromPath() [2/2]

static ToolStripItem BioCore.App.GetMenuItemFromPath ( string  s,
Function  f 
)
static

It takes a string and a function, and adds the function to the menu item specified by the string

Parameters
sThe path to the menu item.
Function
Returns
A ToolStripItem

Definition at line 254 of file App.cs.

◆ GetMenuItems()

static List< ToolStripMenuItem > BioCore.App.GetMenuItems ( )
static

Retrieves all the menu items from the main menu strip

Returns
A list of ToolStripMenuItem objects representing the menu items

Definition at line 223 of file App.cs.

◆ Hide()

static void BioCore.App.Hide ( )
static

Hide() hides all the tools.

Definition at line 65 of file App.cs.

◆ Initialize()

static void BioCore.App.Initialize ( bool  requireImageJ = false)
static

Initialize() is a function that initializes the BioImage Suite Web viewer.

Definition at line 47 of file App.cs.

Member Data Documentation

◆ channelsTool

ChannelsTool BioCore.App.channelsTool = null
static

Definition at line 8 of file App.cs.

◆ console

BioConsole BioCore.App.console = null
static

Definition at line 17 of file App.cs.

◆ lib

Library BioCore.App.lib = null
static

Definition at line 18 of file App.cs.

◆ manager

ROIManager BioCore.App.manager = null
static

Definition at line 7 of file App.cs.

◆ nodeView

NodeView BioCore.App.nodeView = null
static

Definition at line 10 of file App.cs.

◆ recent

List<string> BioCore.App.recent = new List<string>()
static

Definition at line 19 of file App.cs.

◆ recorder

Recorder BioCore.App.recorder = null
static

Definition at line 12 of file App.cs.

◆ runner

Scripting BioCore.App.runner = null
static

Definition at line 11 of file App.cs.

◆ seriesTool

Series BioCore.App.seriesTool = null
static

Definition at line 16 of file App.cs.

◆ stackTools

StackTools BioCore.App.stackTools = null
static

Definition at line 14 of file App.cs.

◆ tabsView

TabsView BioCore.App.tabsView = null
static

Definition at line 9 of file App.cs.

◆ tools

Tools BioCore.App.tools = null
static

Definition at line 13 of file App.cs.

◆ viewer

ImageView BioCore.App.viewer = null
static

Definition at line 15 of file App.cs.

Property Documentation

◆ Annotations

List<ROI> BioCore.App.Annotations
staticget

Definition at line 41 of file App.cs.

◆ Channels

List<Channel> BioCore.App.Channels
staticget

Definition at line 36 of file App.cs.

◆ Image

BioImage BioCore.App.Image
staticget

Gets the BioImage object for the selected image in the ImageView. If no image is selected, returns the image from the tabsView.

The selected BioImage object.

Definition at line 27 of file App.cs.

◆ Initialized

bool BioCore.App.Initialized
staticget

Definition at line 45 of file App.cs.


The documentation for this class was generated from the following file: