[About]
Version=1.0
Author=Nic
Mail=support@hiasm.com

[Type]
Class=Element
Info=Represents a serial port resource.

[Property]
Constructor=Sets the Constructor of the SerialPort class. ARG(enum)|14|0|Constructor,Constructor2,Constructor3,Constructor4,Constructor5,Constructor6,Constructor7
@BaudRate=Sets the serial baud rate. ARG(int)|1|9600
@DataBits=Sets the standard length of data bits per byte. ARG(int)|1|8
@DiscardNull=Sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer. ARG(bool)|14|1|True,False
@DtrEnable=Sets a value that enables the Data Terminal Ready signal during serial communication. ARG(bool)|14|1|True,False
@Handshake=Sets the handshaking protocol for serial port transmission of data. ARG(Handshake)|14|0|None,XOnXOff,RequestToSend,RequestToSendXOnXOff
@Parity=Sets the parity-checking protocol. ARG(Parity)|14|0|None,Odd,Even,Mark,Space
@ParityReplace=Sets the byte (0..255) that replaces invalid bytes in a data stream when a parity error occurs. ARG(Byte)|1|63
@PortName=Sets the port for communications, including but not limited to all available COM ports. ARG(string)|2|COM1
@ReadBufferSize=Sets the size of the SerialPort input buffer. ARG(int)|1|4096
@ReadTimeout=Sets the number of milliseconds before a time-out occurs when a read operation does not finish. ARG(int)|1|-1
@ReceivedBytesThreshold=Sets the number of bytes in the internal input buffer before a DataReceived event occurs. ARG(int)|1|1
@RtsEnable=Sets a value indicating whether the Request to Send signal is enabled during serial communication. ARG(bool)|14|1|True,False
@StopBits=Sets the standard number of stopbits per byte. ARG(StopBits)|14|1|None,One,Two,OnePointFive
@WriteBufferSize=Sets the size of the serial port output buffer. ARG(int)|1|2048
@WriteTimeout=Sets the number of milliseconds before a time-out occurs when a write operation does not finish. ARG(int)|1|-1

[Methods]
*doBreakState=Sets the break signal state. ARG(bool)|1|0
*doClose=Closes the port connection, sets the IsOpen property to false, and disposes of the internal Stream object. ARG()|1|0
*doConstructor=Initializes a new instance of the SerialPort class. ARG()|1|0
*doConstructor2=Initializes a new instance of the SerialPort class using the specified IContainer object. ARG(IContainer container)|1|0
*doConstructor3=Initializes a new instance of the SerialPort class using the specified port name. ARG(string portName)|1|0
*doConstructor4=Initializes a new instance of the SerialPort class using the specified port name and baud rate. ARG(string portName, int baudRate)|1|0
*doConstructor5=Initializes a new instance of the SerialPort class using the specified port name, baud rate, and parity bit. ARG(string portName, int baudRate, Parity parity)|1|0
*doConstructor6=Initializes a new instance of the SerialPort class using the specified port name, baud rate, parity bit, and data bits. ARG(string portName, int baudRate, Parity parity, int dataBits)|1|0
*doConstructor7=Initializes a new instance of the SerialPort class using the specified port name, baud rate, parity bit, data bits, and stop bit. ARG(string portName, int baudRate, Parity parity, int dataBits, StopBits stopBits)|1|0
*doDiscardInBuffer=Discards data from the serial driver's receive buffer. ARG()|1|0
*doDiscardOutBuffer=Discards data from the serial driver's transmit buffer. ARG()|1|0
*doEncoding=Sets the byte encoding for pre- and post-transmission conversion of text. ARG(Encoding)|1|0
*doNewLine=Sets the value used to interpret the end of a call to the ReadLine and WriteLine methods. ARG(string)|1|0
doOpen=Opens a new serial port connection. ARG()|1|0
*doRead=Reads a number of bytes from the SerialPort input buffer and writes those bytes into a byte array at the specified offset. ARG(byte[] buffer, int offset, int count)|1|0
*doRead2=Reads a number of characters from the SerialPort input buffer and writes them into an array of characters at a given offset. ARG(char[] buffer, int offset, int count)|1|0
*doReadTo=Reads a string up to the specified value in the input buffer. ARG(string value)|1|0
doWrite=Writes the specified string to the serial port. ARG(string text)|1|0
*doWrite2=Writes a specified number of bytes to the serial port using data from a buffer. ARG(byte[] buffer, int offset, int count)|1|0
*doWrite3=Writes a specified number of characters to the serial port using data from a buffer. ARG(char[] buffer, int offset, int count)|1|0
*doWriteLine=Writes the specified string and the NewLine value to the output buffer. ARG(string text)|1|0
onDataReceived=Represents the method that will handle the data received event of a SerialPort object. ARG(SerialData)|2|0
onErrorReceived=Represents the method that handles the error event of a SerialPort object. ARG(SerialError)|2|0
onPinChanged=Represents the method that will handle the serial pin changed event of a SerialPort object. ARG(SerialPinChange)|2|0
*onRead=Occurs after invoke the method doRead and returns the result. ARG(int)|2|1
*onReadTo=Occurs after invoke the method doReadTo and returns the result. ARG(string)|2|2
*BaseStream=Returns the underlying Stream object for a SerialPort object. ARG(Stream)|3|10
*BreakState=Returns the break signal state. ARG(bool)|3|104
*BytesToRead=Returns the number of bytes of data in the receive buffer. ARG(int)|3|1
*BytesToWrite=Returns the number of bytes of data in the send buffer. ARG(int)|3|1
*CDHolding=Returns the state of the Carrier Detect line for the port. ARG(bool)|3|104
*CtsHolding=Returns the state of the Clear-to-Send line. ARG(bool)|3|104
*DiscardNull=Returns a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer. ARG(bool)|3|104
*DsrHolding=Returns the state of the Data Set Ready signal. ARG(bool)|3|104
*DtrEnable=Returns a value that enables the Data Terminal Ready signal during serial communication. ARG(bool)|3|104
*Encoding=Returns the byte encoding for pre- and post-transmission conversion of text. ARG(Encoding)|3|0
*GetPortNames=Gets an array of serial port names for the current computer. ARG(string[])|3|13
*Handshake=Returns the handshaking protocol for serial port transmission of data. ARG(Handshake)|3|0
*InfiniteTimeout=Indicates that no time-out should occur. ARG(int)|3|1
*IsOpen=Returns a value indicating the open or closed status of the SerialPort object. ARG(bool)|3|104
*NewLine=Returns the value used to interpret the end of a call to the ReadLine and WriteLine methods. ARG(string)|3|2
*ParityReplace=Returns the byte that replaces invalid bytes in a data stream when a parity error occurs. ARG(byte)|3|0
*ReadBufferSize=Returns the size of the SerialPort input buffer. ARG(int)|3|1
*ReadByte=Synchronously reads one byte from the SerialPort input buffer. ARG(int)|3|1
*ReadChar=Synchronously reads one character from the SerialPort input buffer. ARG(int)|3|1
*ReadExisting=Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the SerialPort object. ARG(string)|3|2
*ReadLine=Reads up to the NewLine value in the input buffer. ARG(string)|3|2
*ReadTimeout=Returns the number of milliseconds before a time-out occurs when a read operation does not finish. ARG(int)|3|1
*ReceivedBytesThreshold=Returns the number of bytes in the internal input buffer before a DataReceived event occurs. ARG(int)|3|1
*RtsEnable=Returns a value indicating whether the Request to Send signal is enabled during serial communication. ARG(bool)|3|104
*WriteBufferSize=Returns the size of the serial port output buffer. ARG(int)|3|1
*WriteTimeout=Returns the number of milliseconds before a time-out occurs when a write operation does not finish. ARG(int)|3|1
SerialPort=Returns the SerialPort object. ARG(SerialPort)|3|0
*baudRate=Defines the baud rate. ARG(int)|4|1
*buffer=Defines the byte array to write the input to. ARG(byte[])|4|13
*container=Defines an interface to a container. ARG(IContainer)|4|0
*count=Defines the number of bytes to read. ARG(int)|4|1
*dataBits=Defines the data bits value. ARG(int)|4|1
*offset=Defines the offset in the buffer array to begin writing. ARG(int)|4|1
*parity=Defines one of the Parity values. ARG(Parity)|4|0
*portName=Defines the port to use (for example, COM1). ARG(string)|4|2
*stopBits=Defines one of the StopBits values. ARG(StopBits)|4|0
Text=Defines the string for output. ARG(string)|4|2
*value=Defines a value that indicates where the read operation stops. ARG(string)|4|2