GXDN: Gurux Developer Network
GXFile Class
NamespacesGurux.FileGXFile
The GXFile component determines methods that make it possible to read and write files.
Members
All Members Constructors Methods Properties Events



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

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

AppendWrite
Determines if data is appended to the file.

BytesReceived
Received byte count.

BytesSent
Sent byte count.

CanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
ClearAfterRead
Retrieves or sets if the file is cleared, after a successfull read operation.

Close()()()
Closes the file watcher.

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.)
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.)
Encoding
Retrieves or sets if the file is cleared, after a successfull read operation.

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.)
FilePath
Directory or file that is watched.

Filter
Filter to be used. For example, if only *.txt files are to be watched, set the filter value to *.txt.

Finalize()()()
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
(Inherited from Component.)
GetAvailableLocaleIdentifiers()()()
Use GetAvailableLocaleIdentifiers method to get supported languages. To use the default language, set value to zero.

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.)
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.)
IncludeSubdirectories
Determines if sub directories are included.

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

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

MaximumSize
Determines the maximum write size of the file.

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.)
OnError
Errors that occur after the connection is established, are sent through this method.

OnMediaStateChange
Media component sends notification, when its state changes.

OnReceived
GXFile component sends received data through this method.

Open()()()
Opens the file watcher.

Properties(IWin32Window)
Shows properties dialog of the file media.

Read(String)
This method is used to read data to the file.

ReadTryCount
Retrieves or sets the amount of times to retry, and read the file, in case it is occupied.

ReadTryDelay
Retrieves or sets the time (in ms) to wait, before retrying to read the file.

RemoveAfterRead
Retrieves or sets if the file is removed, after a successfull read operation.

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

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

Site
Gets or sets the ISite of the Component.
(Inherited from Component.)
ToString()()()
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Write(String, Object)
This method is used to write data to the file.

Inheritance Hierarchy
See Also

Assembly: Gurux.File (Module: Gurux.File) Version: 5.0.0.1