system.componentmodel

Class BackgroundWorker

java.lang.Object

org.mases.jcobridge.netreflection.NetObject

system.MarshalByRefObject

system.componentmodel.Component

system.componentmodel.BackgroundWorker

All Implemented Interfaces:

java.lang.AutoCloseable, IJCOBridgeReflected

public class BackgroundWorker
extends Component

The base .NET class managing System.ComponentModel.BackgroundWorker, System.ComponentModel.EventBasedAsync, Version=9.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a.

.NET documentation at https://learn.microsoft.com/dotnet/api/System.ComponentModel.BackgroundWorker

Powered by JCOBridge: more info at https://www.jcobridge.com

Author:

MASES s.r.l https://masesgroup.com

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	assemblyFullName Fully assembly qualified name: System.ComponentModel.EventBasedAsync, Version=9.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
static java.lang.String	assemblyShortName Assembly name: System.ComponentModel.EventBasedAsync
static java.lang.String	className Qualified class name: System.ComponentModel.BackgroundWorker
static JCType	classType The type managed from JCOBridge.

Fields inherited from class org.mases.jcobridge.netreflection.NetObject

Null

Constructor Summary

Constructors

Constructor and Description
BackgroundWorker() Initializes a new instance by invoking the .NET constructor.
BackgroundWorker(java.lang.Object instance) Internal constructor.

Method Summary

Modifier and Type	Method and Description
void	addDoWork(DoWorkEventHandler handler) Invokes the .NET member addDoWork.
void	addProgressChanged(ProgressChangedEventHandler handler) Invokes the .NET member addProgressChanged.
void	addRunWorkerCompleted(RunWorkerCompletedEventHandler handler) Invokes the .NET member addRunWorkerCompleted.
void	CancelAsync() Invokes the .NET member CancelAsync.
static BackgroundWorker	cast(IJCOBridgeReflected from) Try to cast the IJCOBridgeReflected instance into BackgroundWorker, a cast assert is made to check if types are compatible.
boolean	getCancellationPending() Gets the value of the .NET property CancellationPending.
boolean	getIsBusy() Gets the value of the .NET property IsBusy.
java.lang.String	getJCOAssemblyName() Returns the full name of the assembly of the .NET type.
java.lang.String	getJCOClassName() Returns the full name of the .NET type.
java.lang.Object	getJCOInstance() Returns the underlying object managed by the bridge.
java.lang.String	getJCOObjectName() Returns the name of the .NET type qualified with its assembly.
JCType	getJCOType() Returns the JCType of the .NET type.
boolean	getWorkerReportsProgress() Gets the value of the .NET property WorkerReportsProgress.
boolean	getWorkerSupportsCancellation() Gets the value of the .NET property WorkerSupportsCancellation.
void	removeDoWork(DoWorkEventHandler handler) Invokes the .NET member removeDoWork.
void	removeProgressChanged(ProgressChangedEventHandler handler) Invokes the .NET member removeProgressChanged.
void	removeRunWorkerCompleted(RunWorkerCompletedEventHandler handler) Invokes the .NET member removeRunWorkerCompleted.
void	ReportProgress(int percentProgress) Invokes the .NET member ReportProgress.
void	ReportProgress(int percentProgress, NetObject userState) Invokes the .NET member ReportProgress.
void	RunWorkerAsync() Invokes the .NET member RunWorkerAsync.
void	RunWorkerAsync(NetObject argument) Invokes the .NET member RunWorkerAsync.
void	setJCOInstance(JCObject instance) Sets the underlying object managed by the bridge.
void	setWorkerReportsProgress(boolean WorkerReportsProgress) Sets the value of the .NET property WorkerReportsProgress.
void	setWorkerSupportsCancellation(boolean WorkerSupportsCancellation) Sets the value of the .NET property WorkerSupportsCancellation.

Methods inherited from class system.componentmodel.Component

addDisposed, close, Dispose, getContainer, getSite, removeDisposed, setSite

Methods inherited from class system.MarshalByRefObject

GetLifetimeService, InitializeLifetimeService

Methods inherited from class org.mases.jcobridge.netreflection.NetObject

Equals, Equals, GetHashCode, GetType, hashCode, toString, ToString

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

assemblyFullName

public static final java.lang.String assemblyFullName

Fully assembly qualified name: System.ComponentModel.EventBasedAsync, Version=9.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a

See Also:

Constant Field Values

assemblyShortName

public static final java.lang.String assemblyShortName

Assembly name: System.ComponentModel.EventBasedAsync

See Also:

Constant Field Values

className

public static final java.lang.String className

Qualified class name: System.ComponentModel.BackgroundWorker

See Also:

Constant Field Values

classType

public static JCType classType

The type managed from JCOBridge. See JCType

Constructor Detail

BackgroundWorker

public BackgroundWorker()
                 throws java.lang.Throwable

Initializes a new instance by invoking the .NET constructor.

Throws:

java.lang.Throwable - if the .NET constructor fails

See Also:

.NET documentation

BackgroundWorker

public BackgroundWorker(java.lang.Object instance)
                 throws java.lang.Throwable

Internal constructor. Use with caution

Parameters:

instance - the underlying bridge object: it must be a JCObject

Throws:

java.lang.Throwable - if instance is not a JCObject

Method Detail

addDoWork

public void addDoWork(DoWorkEventHandler handler)
               throws java.lang.Throwable

Invokes the .NET member addDoWork.

Parameters:

handler - the argument of type DoWorkEventHandler

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

addProgressChanged

public void addProgressChanged(ProgressChangedEventHandler handler)
                        throws java.lang.Throwable

Invokes the .NET member addProgressChanged.

Parameters:

handler - the argument of type ProgressChangedEventHandler

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

addRunWorkerCompleted

public void addRunWorkerCompleted(RunWorkerCompletedEventHandler handler)
                           throws java.lang.Throwable

Invokes the .NET member addRunWorkerCompleted.

Parameters:

handler - the argument of type RunWorkerCompletedEventHandler

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

CancelAsync

public void CancelAsync()
                 throws java.lang.Throwable,
                        ArgumentNullException,
                        ArgumentException,
                        PlatformNotSupportedException,
                        ArgumentOutOfRangeException,
                        NotSupportedException,
                        CultureNotFoundException,
                        ObjectDisposedException,
                        InvalidOperationException

Invokes the .NET member CancelAsync.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

See Also:

.NET documentation

cast

public static BackgroundWorker cast(IJCOBridgeReflected from)
                             throws java.lang.Throwable

Try to cast the IJCOBridgeReflected instance into BackgroundWorker, a cast assert is made to check if types are compatible.

Parameters:

from - IJCOBridgeReflected instance to be casted

Returns:

BackgroundWorker instance

Throws:

java.lang.Throwable - in case of error during cast operation

getCancellationPending

public boolean getCancellationPending()
                               throws java.lang.Throwable

Gets the value of the .NET property CancellationPending.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getIsBusy

public boolean getIsBusy()
                  throws java.lang.Throwable

Gets the value of the .NET property IsBusy.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getJCOAssemblyName

public java.lang.String getJCOAssemblyName()

Description copied from class: NetObject

Returns the full name of the assembly of the .NET type.

Specified by:

getJCOAssemblyName in interface IJCOBridgeReflected

Overrides:

getJCOAssemblyName in class Component

Returns:

the full assembly name

getJCOClassName

public java.lang.String getJCOClassName()

Description copied from class: NetObject

Returns the full name of the .NET type.

Specified by:

getJCOClassName in interface IJCOBridgeReflected

Overrides:

getJCOClassName in class Component

Returns:

the full class name

getJCOInstance

public java.lang.Object getJCOInstance()

Description copied from class: NetObject

Returns the underlying object managed by the bridge.

Specified by:

getJCOInstance in interface IJCOBridgeReflected

Overrides:

getJCOInstance in class Component

Returns:

the underlying object, or null if there is none

getJCOObjectName

public java.lang.String getJCOObjectName()

Description copied from class: NetObject

Returns the name of the .NET type qualified with its assembly.

Specified by:

getJCOObjectName in interface IJCOBridgeReflected

Overrides:

getJCOObjectName in class Component

Returns:

the assembly qualified name

getJCOType

public JCType getJCOType()

Description copied from class: NetObject

Returns the JCType of the .NET type.

Specified by:

getJCOType in interface IJCOBridgeReflected

Overrides:

getJCOType in class Component

Returns:

the type of the .NET class

getWorkerReportsProgress

public boolean getWorkerReportsProgress()
                                 throws java.lang.Throwable

Gets the value of the .NET property WorkerReportsProgress.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

getWorkerSupportsCancellation

public boolean getWorkerSupportsCancellation()
                                      throws java.lang.Throwable

Gets the value of the .NET property WorkerSupportsCancellation.

Returns:

the value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

removeDoWork

public void removeDoWork(DoWorkEventHandler handler)
                  throws java.lang.Throwable

Invokes the .NET member removeDoWork.

Parameters:

handler - the argument of type DoWorkEventHandler

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

removeProgressChanged

public void removeProgressChanged(ProgressChangedEventHandler handler)
                           throws java.lang.Throwable

Invokes the .NET member removeProgressChanged.

Parameters:

handler - the argument of type ProgressChangedEventHandler

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

removeRunWorkerCompleted

public void removeRunWorkerCompleted(RunWorkerCompletedEventHandler handler)
                              throws java.lang.Throwable

Invokes the .NET member removeRunWorkerCompleted.

Parameters:

handler - the argument of type RunWorkerCompletedEventHandler

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

ReportProgress

public void ReportProgress(int percentProgress)
                    throws java.lang.Throwable,
                           ArgumentNullException,
                           ArgumentException,
                           PlatformNotSupportedException,
                           ArgumentOutOfRangeException,
                           CultureNotFoundException,
                           NotSupportedException,
                           InvalidOperationException,
                           ObjectDisposedException,
                           OutOfMemoryException

Invokes the .NET member ReportProgress.

Parameters:

percentProgress - the argument of type int

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

ReportProgress

public void ReportProgress(int percentProgress,
                           NetObject userState)
                    throws java.lang.Throwable,
                           ArgumentNullException,
                           ArgumentException,
                           PlatformNotSupportedException,
                           ArgumentOutOfRangeException,
                           NotSupportedException,
                           CultureNotFoundException,
                           ObjectDisposedException,
                           InvalidOperationException,
                           OutOfMemoryException

Invokes the .NET member ReportProgress.

Parameters:

percentProgress - the argument of type int

userState - the argument of type NetObject

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

See Also:

.NET documentation

RunWorkerAsync

public void RunWorkerAsync()
                    throws java.lang.Throwable,
                           ArgumentNullException,
                           ArgumentException,
                           PlatformNotSupportedException,
                           ArgumentOutOfRangeException,
                           CultureNotFoundException,
                           NotSupportedException,
                           InvalidOperationException,
                           ObjectDisposedException,
                           OutOfMemoryException,
                           EventSourceException

Invokes the .NET member RunWorkerAsync.

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

EventSourceException - if the .NET member raises it

See Also:

.NET documentation

RunWorkerAsync

public void RunWorkerAsync(NetObject argument)
                    throws java.lang.Throwable,
                           ArgumentNullException,
                           ArgumentException,
                           PlatformNotSupportedException,
                           ArgumentOutOfRangeException,
                           NotSupportedException,
                           CultureNotFoundException,
                           ObjectDisposedException,
                           InvalidOperationException,
                           OutOfMemoryException,
                           IndexOutOfRangeException,
                           EventSourceException

Invokes the .NET member RunWorkerAsync.

Parameters:

argument - the argument of type NetObject

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

ArgumentNullException - if the .NET member raises it

ArgumentException - if the .NET member raises it

PlatformNotSupportedException - if the .NET member raises it

ArgumentOutOfRangeException - if the .NET member raises it

NotSupportedException - if the .NET member raises it

CultureNotFoundException - if the .NET member raises it

ObjectDisposedException - if the .NET member raises it

InvalidOperationException - if the .NET member raises it

OutOfMemoryException - if the .NET member raises it

IndexOutOfRangeException - if the .NET member raises it

EventSourceException - if the .NET member raises it

See Also:

.NET documentation

setJCOInstance

public void setJCOInstance(JCObject instance)

Description copied from class: NetObject

Sets the underlying object managed by the bridge.

Overrides:

setJCOInstance in class Component

Parameters:

instance - the new underlying object

setWorkerReportsProgress

public void setWorkerReportsProgress(boolean WorkerReportsProgress)
                              throws java.lang.Throwable

Sets the value of the .NET property WorkerReportsProgress.

Parameters:

WorkerReportsProgress - the new value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation

setWorkerSupportsCancellation

public void setWorkerSupportsCancellation(boolean WorkerSupportsCancellation)
                                   throws java.lang.Throwable

Sets the value of the .NET property WorkerSupportsCancellation.

Parameters:

WorkerSupportsCancellation - the new value of the property

Throws:

java.lang.Throwable - if the call fails in the bridge or in the CLR

See Also:

.NET documentation