LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
Remove Method
See Also 
Leadtools.Multimedia Namespace > Processors Class : Remove Method



item
The Processor item to remove.
item
The Processor item to remove.
Removes a Processor from the collection.

Syntax

Visual Basic (Declaration) 
Public Function Remove( _
   ByVal item As Processor _
) As Boolean
Visual Basic (Usage)Copy Code
Dim instance As Processors
Dim item As Processor
Dim value As Boolean
 
value = instance.Remove(item)
C# 
public bool Remove( 
   Processor item
)
C++/CLI 
public:
bool Remove( 
   Processor^ item
) 

Parameters

item
The Processor item to remove.

Return Value

true if the item was removed from the collection; false, if the item was not found.

Example

Visual BasicCopy Code
Public _result As Boolean = False
Public _form As PlayCtrlForm = New PlayCtrlForm()
Public Sub SelectProcessorsExample()
   ' reference the play control
   Dim playctrl As PlayCtrl = _form.PlayCtrl

   Try
      ' get the available video processors
      Dim allProcs As VideoProcessors = playctrl.VideoProcessors

      ' get the available video processors
      Dim selProcs As VideoProcessors = playctrl.SelectedVideoProcessors

      ' get the count of selected video processors
      Dim n As Integer = selProcs.Count

      ' add and remove some processors
      selProcs.Add(allProcs.Mosaic)
      selProcs.Add(allProcs.Emboss)
      selProcs.Remove(allProcs.Mosaic)

      ' get the count again
      Dim m As Integer = selProcs.Count

      ' set the result to what we expect
      _result = (m > n AndAlso n = 0)
   Catch e1 As Exception
      _result = False
   End Try
End Sub
C#Copy Code
public bool _result = false;
public PlayCtrlForm _form = new PlayCtrlForm();
public void SelectProcessorsExample()
{
   // reference the play control
   PlayCtrl playctrl = _form.PlayCtrl;

   try
   {
      // get the available video processors
      VideoProcessors allProcs = playctrl.VideoProcessors;

      // get the available video processors
      VideoProcessors selProcs = playctrl.SelectedVideoProcessors;

      // get the count of selected video processors
      int n = selProcs.Count;

      // add and remove some processors
      selProcs.Add(allProcs.Mosaic);
      selProcs.Add(allProcs.Emboss);
      selProcs.Remove(allProcs.Mosaic);

      // get the count again
      int m = selProcs.Count;

      // set the result to what we expect
      _result = (m > n && n == 0);
   }
   catch (Exception)
   {
      _result = false;
   }
}

Remarks

Removes a Processor from the collection. If the method fails, an error is raised. For more information, refer to the Error Codes.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also