Class PenController

Inheritance
object
PenController
Inherited Members
Namespace: Neosmartpen.Net
Assembly: Neosmartpen.Net.dll
Syntax
public class PenController

Constructors

| Edit this page View Source

PenController()

Declaration
public PenController()

Properties

| Edit this page View Source

PenClient

Gets binded PenClient
Declaration
public IPenClient PenClient { get; set; }
Property Value
Type Description
IPenClient
| Edit this page View Source

Protocol

Get Protocol version
Declaration
public int Protocol { get; set; }
Property Value
Type Description
int

Methods

| Edit this page View Source

AddAvailableNote()

Sets the available notebook type
Declaration
public void AddAvailableNote()
| Edit this page View Source

AddAvailableNote(int, int, int[])

Sets the available notebook type
Declaration
public void AddAvailableNote(int section, int owner, int[] notes = null)
Parameters
Type Name Description
int section The section Id of the paper
int owner The owner Id of the paper
int[] notes The array of notebook Id list
| Edit this page View Source

AddAvailableNote(int[], int[])

Sets the available notebook types
Declaration
public void AddAvailableNote(int[] section, int[] owner)
Parameters
Type Name Description
int[] section The array of section Id of the paper list
int[] owner The array of owner Id of the paper list
| Edit this page View Source

CreateProfile(string, byte[])

Request to create profile
Declaration
public void CreateProfile(string profileName, byte[] password)
Parameters
Type Name Description
string profileName Name of the profile to be created
byte[] password Password of profile
| Edit this page View Source

DeleteProfile(string, byte[])

Request to delete profile
Declaration
public void DeleteProfile(string profileName, byte[] password)
Parameters
Type Name Description
string profileName Name of the profile to be deleted
byte[] password password of profile
| Edit this page View Source

DeleteProfileValues(string, byte[], string[])

Request to delete data
Declaration
public void DeleteProfileValues(string profileName, byte[] password, string[] keys)
Parameters
Type Name Description
string profileName profile name
byte[] password password
string[] keys key array
| Edit this page View Source

GetPressureCalibrationFactor(int)

Declaration
public float GetPressureCalibrationFactor(int index)
Parameters
Type Name Description
int index
Returns
Type Description
float
| Edit this page View Source

GetProfileInfo(string)

Request information of the profile
Declaration
public void GetProfileInfo(string profileName)
Parameters
Type Name Description
string profileName profile's name
| Edit this page View Source

InputPassword(string)

If you request a password when the pen is locked, enter it
Declaration
public void InputPassword(string password)
Parameters
Type Name Description
string password Specifies the password for authentication. password is a string, maximum length is 16 bytes
| Edit this page View Source

IsSupportPenProfile()

Declaration
public bool IsSupportPenProfile()
Returns
Type Description
bool
| Edit this page View Source

OnConnected()

Fired when a connection is made, override to handle in your own code.
Declaration
public void OnConnected()
| Edit this page View Source

OnDataReceived(byte[])

Fired when read data, override to parse data in your implementation
Declaration
public void OnDataReceived(byte[] buff)
Parameters
Type Name Description
byte[] buff byte array of new data
| Edit this page View Source

OnDisconnected()

Fired when a connection is destroyed, override to handle in your own code.
Declaration
public void OnDisconnected()
| Edit this page View Source

ReadProfileValues(string, string[])

Request to get data from profile
Declaration
public void ReadProfileValues(string profileName, string[] keys)
Parameters
Type Name Description
string profileName profile name
string[] keys key array
| Edit this page View Source

RequestBeepAndLight()

Request Beeps and light on.
Declaration
public void RequestBeepAndLight()
| Edit this page View Source

RequestFirmwareInstallation(string, string)

Requests the firmware installation
Declaration
public void RequestFirmwareInstallation(string file, string version)
Parameters
Type Name Description
string file Represents a binary file of firmware
string version Version of firmware typed string
| Edit this page View Source

RequestOfflineData(int, int)

Requests the transmission of offline data
Declaration
public void RequestOfflineData(int section, int owner)
Parameters
Type Name Description
int section The section Id of the paper
int owner The owner Id of the paper
| Edit this page View Source

RequestOfflineData(int, int, int, bool, int[])

Requests the transmission of offline data
Declaration
public bool RequestOfflineData(int section, int owner, int note, bool deleteOnFinished = true, int[] pages = null)
Parameters
Type Name Description
int section The section Id of the paper
int owner The owner Id of the paper
int note
bool deleteOnFinished delete offline data when transmission is finished
int[] pages The array of page's number
Returns
Type Description
bool
| Edit this page View Source

RequestOfflineData(int, int, int[])

Requests the transmission of offline data
Declaration
public bool RequestOfflineData(int section, int owner, int[] notes)
Parameters
Type Name Description
int section The section Id of the paper
int owner The owner Id of the paper
int[] notes The array of notebook Id list
Returns
Type Description
bool
| Edit this page View Source

RequestOfflineDataList()

Requests the list of Offline data
Declaration
public void RequestOfflineDataList()
| Edit this page View Source

RequestPenStatus()

Request the status of the pen
Declaration
public void RequestPenStatus()
| Edit this page View Source

RequestRemoveOfflineData(int, int, int[])

Request to remove offline data in device.
Declaration
public void RequestRemoveOfflineData(int section, int owner, int[] notes)
Parameters
Type Name Description
int section The Section Id of the paper
int owner The Owner Id of the paper
int[] notes The Note Id's array of the paper
| Edit this page View Source

SetAutoPowerOffTime(short)

Sets the power-off setting when there is no input for a certain period of time
Declaration
public void SetAutoPowerOffTime(short minute)
Parameters
Type Name Description
short minute minute of maximum idle time, staying power on (0~)
| Edit this page View Source

SetAutoPowerOnEnable(bool)

Sets the power-on setting when the pen tip is pressed
Declaration
public void SetAutoPowerOnEnable(bool enable)
Parameters
Type Name Description
bool enable true if you want enable setting; otherwise, false
| Edit this page View Source

SetBeepSoundEnable(bool)

Sets the status of the beep sound property
Declaration
public void SetBeepSoundEnable(bool enable)
Parameters
Type Name Description
bool enable true if you want enable setting; otherwise, false
| Edit this page View Source

SetBtLocalName(string)

Sets the local name of the bluetooth device property.
Declaration
public void SetBtLocalName(string btLocalName)
Parameters
Type Name Description
string btLocalName Bluetooth local name to set
| Edit this page View Source

SetColor(int)

Sets the color of LED
Declaration
public void SetColor(int color)
Parameters
Type Name Description
int color integer type color formatted 0xAARRGGBB
| Edit this page View Source

SetDataTransmissionType(DataTransmissionType)

Sets the status of data transmission type property that determine if data transmission type is event or request-response.
Declaration
public void SetDataTransmissionType(DataTransmissionType mode)
Parameters
Type Name Description
DataTransmissionType mode enum of DataTransmissionType
| Edit this page View Source

SetDownSampling(bool)

Sets the status of the down sampling property. Downsampling is a function of avoiding unnecessary data communication by omitting coordinates at the same position.
Declaration
public void SetDownSampling(bool enable)
Parameters
Type Name Description
bool enable true if you want to enable down sampling, otherwise false.
| Edit this page View Source

SetFscSensitivity(short)

Sets the value of the pen's sensitivity property that controls the force sensor(c-type) of pen.
Declaration
public void SetFscSensitivity(short step)
Parameters
Type Name Description
short step the value of sensitivity. (0~4, 0 means maximum sensitivity)
| Edit this page View Source

SetOfflineDataEnable(bool)

Sets the usage of offline data
Declaration
public void SetOfflineDataEnable(bool enable)
Parameters
Type Name Description
bool enable true if you want enable setting; otherwise, false
| Edit this page View Source

SetPassword(string, string)

Change password
Declaration
public bool SetPassword(string oldone, string newone = "")
Parameters
Type Name Description
string oldone old password
string newone new password
Returns
Type Description
bool
| Edit this page View Source

SetPenCapPowerOnOffEnable(bool)

Sets the property that can be control by cap of pen
Declaration
public void SetPenCapPowerOnOffEnable(bool enable)
Parameters
Type Name Description
bool enable true if you want enable setting; otherwise, false
| Edit this page View Source

SetPressureCalibrateFactor(int, int, int, int, int, int)

Declaration
public void SetPressureCalibrateFactor(int cPX1, int cPY1, int cPX2, int cPY2, int cPX3, int cPY3)
Parameters
Type Name Description
int cPX1
int cPY1
int cPX2
int cPY2
int cPX3
int cPY3
| Edit this page View Source

SetRtcTime(long)

Sets the pen's RTC timestamp
Declaration
public void SetRtcTime(long timetick)
Parameters
Type Name Description
long timetick milisecond timestamp tick (from 1970-01-01)
| Edit this page View Source

SetSensitivity(short)

Sets the value of the pen's sensitivity property that controls the force sensor of pen
Declaration
public void SetSensitivity(short step)
Parameters
Type Name Description
short step the value of sensitivity. (0~4, 0 means maximum sensitivity)
| Edit this page View Source

SetUsbMode(UsbMode)

Sets the status of usb mode property that determine if usb mode is disk or bulk. You can choose between Disk mode, which is used as a removable disk, and Bulk mode, which is capable of high volume data communication, when connected with usb
Declaration
public void SetUsbMode(UsbMode mode)
Parameters
Type Name Description
UsbMode mode enum of UsbMode
| Edit this page View Source

SuspendFirmwareInstallation()

Request to suspend firmware installation
Declaration
public void SuspendFirmwareInstallation()
| Edit this page View Source

WriteProfileValues(string, byte[], string[], byte[][])

Request to write data
Declaration
public void WriteProfileValues(string profileName, byte[] password, string[] keys, byte[][] data)
Parameters
Type Name Description
string profileName profile name
byte[] password password
string[] keys key array
byte[][] data data

Events

| Edit this page View Source

Authenticated

Occurs when authentication is complete, the password entered has been verified.
Declaration
public event TypedEventHandler<IPenClient, object> Authenticated
Event Type
Type Description
TypedEventHandler<IPenClient, object>
| Edit this page View Source

AutoPowerOffTimeChanged

Occurs when the power-off setting is applied when there is no input for a certain period of time
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> AutoPowerOffTimeChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

AutoPowerOnChanged

Occurs when the power-on setting is applied when the pen tip is pressed
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> AutoPowerOnChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

AvailableNoteAdded

Occurs when the note information to be used is added
Declaration
public event TypedEventHandler<IPenClient, object> AvailableNoteAdded
Event Type
Type Description
TypedEventHandler<IPenClient, object>
| Edit this page View Source

BatteryAlarmReceived

Occurs when the pen's battery status changes
Declaration
public event TypedEventHandler<IPenClient, BatteryAlarmReceivedEventArgs> BatteryAlarmReceived
Event Type
Type Description
TypedEventHandler<IPenClient, BatteryAlarmReceivedEventArgs>
| Edit this page View Source

BeepAndLightChanged

Occurs when pen's beep and light is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> BeepAndLightChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

BeepSoundChanged

Occurs when the beep setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> BeepSoundChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

BtLocalNameChanged

Occurs when the pen's new bt local name setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> BtLocalNameChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

Connected

Occurs when a connection is made
Declaration
public event TypedEventHandler<IPenClient, ConnectedEventArgs> Connected
Event Type
Type Description
TypedEventHandler<IPenClient, ConnectedEventArgs>
| Edit this page View Source

DataTransmissionTypeChanged

Occurs when the pen's new data transmission type setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> DataTransmissionTypeChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

Disconnected

Occurs when a connection is closed
Declaration
public event TypedEventHandler<IPenClient, object> Disconnected
Event Type
Type Description
TypedEventHandler<IPenClient, object>
| Edit this page View Source

DotReceived

Occurs when new coordinate data is received
Declaration
public event TypedEventHandler<IPenClient, DotReceivedEventArgs> DotReceived
Event Type
Type Description
TypedEventHandler<IPenClient, DotReceivedEventArgs>
| Edit this page View Source

DownSamplingChanged

Occurs when the pen's new down sampling setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> DownSamplingChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

ErrorDetected

Occurs when error received
Declaration
public event TypedEventHandler<IPenClient, ErrorDetectedEventArgs> ErrorDetected
Event Type
Type Description
TypedEventHandler<IPenClient, ErrorDetectedEventArgs>
| Edit this page View Source

FirmwareInstallationFinished

Occurs when firmware installation is complete
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> FirmwareInstallationFinished
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

FirmwareInstallationStarted

Occurs when firmware installation is started
Declaration
public event TypedEventHandler<IPenClient, object> FirmwareInstallationStarted
Event Type
Type Description
TypedEventHandler<IPenClient, object>
| Edit this page View Source

FirmwareInstallationStatusUpdated

Notice the progress while the firmware installation is in progress
Declaration
public event TypedEventHandler<IPenClient, ProgressChangeEventArgs> FirmwareInstallationStatusUpdated
Event Type
Type Description
TypedEventHandler<IPenClient, ProgressChangeEventArgs>
| Edit this page View Source

FscSensitivityChanged

Occurs when the pen's new fsc sensitivity setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> FscSensitivityChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

HoverChanged

Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> HoverChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

OfflineDataChanged

Occurs when settings to store offline data are applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> OfflineDataChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

OfflineDataDownloadStarted

Occurs when offline downloading starts
Declaration
public event TypedEventHandler<IPenClient, object> OfflineDataDownloadStarted
Event Type
Type Description
TypedEventHandler<IPenClient, object>
| Edit this page View Source

OfflineDataListReceived

Occurs when a list of offline data is received
Declaration
public event TypedEventHandler<IPenClient, OfflineDataListReceivedEventArgs> OfflineDataListReceived
Event Type
Type Description
TypedEventHandler<IPenClient, OfflineDataListReceivedEventArgs>
| Edit this page View Source

OfflineDataRemoved

Occurs when an offline data is removed
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> OfflineDataRemoved
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

OfflineDownloadFinished

Occurs when finished offline data downloading
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> OfflineDownloadFinished
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

OfflineStrokeReceived

Occurs when an offline stroke is received
Declaration
public event TypedEventHandler<IPenClient, OfflineStrokeReceivedEventArgs> OfflineStrokeReceived
Event Type
Type Description
TypedEventHandler<IPenClient, OfflineStrokeReceivedEventArgs>
| Edit this page View Source

PasswordChanged

Occurs when the pen's new password is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> PasswordChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

PasswordRequested

Occurs when requesting a password when the pen is locked with a password
Declaration
public event TypedEventHandler<IPenClient, PasswordRequestedEventArgs> PasswordRequested
Event Type
Type Description
TypedEventHandler<IPenClient, PasswordRequestedEventArgs>
| Edit this page View Source

PenCapPowerOnOffChanged

Occurs when the cap is closed and the power-on and power-off setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> PenCapPowerOnOffChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

PenColorChanged

Occurs when the pen's new LED color value is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> PenColorChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

PenProfileReceived

Occurs when a response to an operation request for a pen profile is received
Declaration
public event TypedEventHandler<IPenClient, PenProfileReceivedEventArgs> PenProfileReceived
Event Type
Type Description
TypedEventHandler<IPenClient, PenProfileReceivedEventArgs>
| Edit this page View Source

PenStatusReceived

Occurs when a status of pen is received
Declaration
public event TypedEventHandler<IPenClient, PenStatusReceivedEventArgs> PenStatusReceived
Event Type
Type Description
TypedEventHandler<IPenClient, PenStatusReceivedEventArgs>
| Edit this page View Source

RtcTimeChanged

Occurs when pen's RTC time is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> RtcTimeChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

SensitivityChanged

Occurs when the pen's new fsr sensitivity setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> SensitivityChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>
| Edit this page View Source

UsbModeChanged

Occurs when the pen's new usb mode setting is applied
Declaration
public event TypedEventHandler<IPenClient, SimpleResultEventArgs> UsbModeChanged
Event Type
Type Description
TypedEventHandler<IPenClient, SimpleResultEventArgs>