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



name
A string value representing the name of the Processor to find.
name
A string value representing the name of the Processor to find.
Returns the index of the first occurrence of a Processor object whose name matches the given string.

Syntax

Visual Basic (Declaration) 
Overloads Public Function IndexOf( _
   ByVal name As String _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As Processors
Dim name As String
Dim value As Integer
 
value = instance.IndexOf(name)
C# 
public int IndexOf( 
   string name
)
C++/CLI 
public:
int IndexOf( 
   String^ name
) 

Parameters

name
A string value representing the name of the Processor to find.

Return Value

The zero-based index position of the Processor item found, or -1 if not found.

Example

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

   Try
      ' get the play controls available audio processors
      Dim allProcs As AudioProcessors = playctrl.AudioProcessors

      ' get the play controls selected audio processors
      Dim selProcs As AudioProcessors = playctrl.SelectedAudioProcessors

      ' add a couple processors to the selected audio processors collection
      selProcs.Add(allProcs.Chorus)
      selProcs.Add(allProcs.Echo)

      ' get the indexes of added audio processors
      Dim i As Integer = selProcs.IndexOf(allProcs.Chorus)
      Dim j As Integer = selProcs.IndexOf(allProcs.Echo)

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

   try
   {
      // get the play controls available audio processors
      AudioProcessors allProcs = playctrl.AudioProcessors;

      // get the play controls selected audio processors
      AudioProcessors selProcs = playctrl.SelectedAudioProcessors;

      // add a couple processors to the selected audio processors collection
      selProcs.Add(allProcs.Chorus);
      selProcs.Add(allProcs.Echo);

      // get the indexes of added audio processors
      int i = selProcs.IndexOf(allProcs.Chorus);
      int j = selProcs.IndexOf(allProcs.Echo);

      // set the result to what we expect
      _result = (selProcs[i] == selProcs.Chorus && selProcs[j] == selProcs.Echo);
      //_result = (i > -1 && j > -1 && i != j);
   }            
   catch (Exception)
   {
      _result = false;
   }
}

Remarks

Returns the index of the first occurrence of a Processor object whose name matches the given string.

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