C# Class Acrolinx.Sdk.Sidebar.AcrolinxSidebar

Inheritance: System.Windows.Forms.UserControl, ISidebar
Show file Open project: acrolinx/acrolinx-sidebar-demo-dotnet Class Usage Examples

Private Properties

Property Type Description
Eval dynamic
FireChecked void
FireInitFinished void
FireReplaceRanges void
FireRequestCheck void
FireSelectRanges void
GetInternalUrl string
GuessMainComponentAndHostApplication void
HideServerSelectorIfServerAddressParameterSet void
RegisterComponents void
SetDefaultClientLocaleIfNotSet void
SetDefaultForSidebarLocationAndShowServerSelectorIfLocationNotSet void
SetDefaults void
ShowServerSelectorIfServerAddressNotSet void
getServerAddress string
webBrowser_DocumentCompleted void
webBrowser_Navigated void

Public Methods

Method Description
AcrolinxSidebar ( ) : System
Check ( IDocument document ) : String
InvalidateRanges ( String checkId, IReadOnlyList matches ) : void
RegisterClientComponent ( Assembly assembly, string humanReadableName, SoftwareComponentCategory category ) : void
RegisterClientComponent ( string id, string name, string version, SoftwareComponentCategory category ) : void
Start ( ) : void
Start ( string serverAddress ) : void

Private Methods

Method Description
Eval ( string code ) : dynamic
FireChecked ( string checkId, Range range ) : void
FireInitFinished ( ) : void
FireReplaceRanges ( string checkId, IEnumerable matches ) : void
FireRequestCheck ( ) : void
FireSelectRanges ( string checkId, IEnumerable matches ) : void
GetInternalUrl ( ) : string
GuessMainComponentAndHostApplication ( Assembly callingAssembly ) : void
HideServerSelectorIfServerAddressParameterSet ( string serverAddress ) : void
RegisterComponents ( Assembly callingAssembly ) : void
SetDefaultClientLocaleIfNotSet ( ) : void
SetDefaultForSidebarLocationAndShowServerSelectorIfLocationNotSet ( string serverAddress ) : void
SetDefaults ( string serverAddress ) : void
ShowServerSelectorIfServerAddressNotSet ( ) : void
getServerAddress ( string serverAddress ) : string
webBrowser_DocumentCompleted ( object sender, System.Windows.Forms.WebBrowserDocumentCompletedEventArgs e ) : void
webBrowser_Navigated ( object sender, System.Windows.Forms.WebBrowserNavigatedEventArgs e ) : void

Method Details

AcrolinxSidebar() public method

public AcrolinxSidebar ( ) : System
return System

Check() public method

public Check ( IDocument document ) : String
document IDocument
return String

InvalidateRanges() public method

public InvalidateRanges ( String checkId, IReadOnlyList matches ) : void
checkId String
matches IReadOnlyList
return void

RegisterClientComponent() public method

public RegisterClientComponent ( Assembly assembly, string humanReadableName, SoftwareComponentCategory category ) : void
assembly System.Reflection.Assembly
humanReadableName string
category SoftwareComponentCategory
return void

RegisterClientComponent() public method

public RegisterClientComponent ( string id, string name, string version, SoftwareComponentCategory category ) : void
id string
name string
version string
category SoftwareComponentCategory
return void

Start() public method

public Start ( ) : void
return void

Start() public method

public Start ( string serverAddress ) : void
serverAddress string
return void