GXDN: Gurux Developer Network
GXSerial Class
NamespacesGurux.SerialGXSerial
The GXSerial component determines methods that make the communication possible using serial port.
Members
All Members Constructors Methods Properties Events



Icon Member Description
GXSerial()()()
Initializes a new instance of the GXSerial class

AboutBox()()()
Displays the copyright of the control, user license, and version information, in a dialog box.

BitRate
Retrieves or sets the bit rate.

BytesReceived
Received byte count.

BytesSent
Sent byte count.

CanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Close()()()
Closes the active connection.

Container
Gets the IContainer that contains the Component.
(Inherited from Component.)
CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
DataBits
Retrieves or sets the data bits value.

DataTerminalReady
Retrieves or sets the DTR (Data-Terminal-Ready) value.

DesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Dispose()()()
Releases all resources used by the Component.
(Inherited from Component.)
Dispose(Boolean)
Releases the unmanaged resources used by the Component and optionally releases the managed resources.
(Inherited from Component.)
Disposed
Occurs when the component is disposed by a call to the Dispose()()() method.
(Inherited from Component.)
Equals(Object)
Determines whether two objects are equal.
(Overrides Object.Equals(Object).)
Events
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Finalize()()()
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
FlowControl
Determines the flow control value.

GetAvailableLocaleIdentifiers()()()
Use GetAvailableLocaleIdentifiers method to get supported languages. To use the default language, set value to zero.

GetAvailablePorts()()()
Returns collection of available serial port names.

GetHashCode()()()
Serves as a hash function for a particular type.
(Overrides Object.GetHashCode()()().)
GetLifetimeService()()()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
GetReplyData(VariantType)
Retrieves reply data.

GetService(Type)
Returns an object that represents a service provided by the Component or by its Container.
(Inherited from Component.)
GetSettings()()()
Gets Media settings as a XML string.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Handle()()()
Gets the serial port handle that the control is bound to.

InitializeLifetimeService()()()
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
IsOpen
Cheks if the connection is open.

LocaleIdentifier
The localization identifier, which determines the used language. To use default language, set value to zero.

MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OnDiagnosticEventsOccurred
Media component notifies diagnostic events. Required events must be determined with UseCommunicationDiagnostics. By default, no events are notified.

OnError
Errors that occur after the connection is established, are sent through this method.

OnMediaStateChange
Media component sends notification, when its state changes.

OnReceived
GXSerial component sends received data through this method.

Open()()()
Opens the specified port and the connection.

Parity
Retrieves or sets the parity of serial communication.

ParityCheck
Retrieves or sets the parity check of serial communication.

Port
Retrieves or sets the name of the serial port, which is used for communication.

Properties(IWin32Window)
Shows the serial port properties dialog.

ReplyDataSize
The amount of bytes in the reply buffer, after the SendSync method.

RequestToSend
Retrieves or sets the RTS (Request-To-Send) value.

ResetByteCounters()()()
Resets BytesReceived and BytesSent counters.

Send(Object, VariantType)
Sends data asynchronously.
No reply from the receiver, whether or not the operation was successful, is expected.

SendSync(Object, VariantType, Object, Int32, Int32, Boolean, VariantType, Object%)
Sends data synchronously.
A reply from the receiver, whether the send operation was successful, or if the data needs to be resent, is expected.

SendSyncComplete
Determines if all sync reply data is received. Data is received to the synchronous buffer until SendSyncComplete is set to True.

SetSettings(String)
Sets Media settings as a XML string.

Site
Gets or sets the ISite of the Component.
(Inherited from Component.)
StopBits
Retrieves or sets the stop bits value.

ToString()()()
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
UseCommunicationDiagnostics
Determines which communication statics are notified.

WaitMoreReplyData(Object, Int32, Int32, Boolean, VariantType, Object%)
Waits for reply data synchronously.

Inheritance Hierarchy
Object
MarshalByRefObject
  Component
    GXSerial
See Also

Assembly: Gurux.Serial (Module: Gurux.Serial) Version: 5.0.0.2