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 > Compressors Class > IndexOf Method : IndexOf(String) Method



name
The name of the compressor item to locate in the collection.
name
The name of the compressor item to locate in the collection.
Determines the index of a specific Compressor item in the collection.

Syntax

Visual Basic (Declaration) 
Overloads Public Function IndexOf( _
   ByVal name As String _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As Compressors
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
The name of the compressor item to locate in the collection.

Return Value

The zero-based index of the found item; otherwise -1 if no item found.

Example

Visual BasicCopy Code
Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public Sub IndexContainsExample()
   ' reference the capture control
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

   Try
      ' select a video device, use your device name here instead of Analog
      If capturectrl.VideoDevices("Analog") Is Nothing Then
         Throw New Exception("No Analog video tuner device available")
      End If

      capturectrl.VideoDevices("Analog").Selected = True

      ' reference the video compressors object
      Dim compressors As Compressors = capturectrl.VideoCompressors

      ' check the index of a video compressor
      Dim i As Integer = compressors.IndexOf(capturectrl.VideoCompressors.Mpeg2)

      Dim cmp As Compressor = Nothing
      If i > -1 Then
         ' access the compressor via the collection indexer
         cmp = compressors(i)
      End If

      ' check if the collection contains this input 
      ' (it should we just got it with IndexOf above)
      If compressors.Contains(cmp) Then
         ' set the result to what we expect
         _result = True
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub
C#Copy Code
public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void IndexContainsExample()
{
   // reference the capture control
   CaptureCtrl capturectrl = _form.CaptureCtrl;

   try
   {
      // select a video device, use your device name here instead of Analog
      if (capturectrl.VideoDevices["Analog"] == null)
         throw new Exception("No Analog video tuner device available");

      capturectrl.VideoDevices["Analog"].Selected = true;

      // reference the video compressors object
      Compressors compressors = capturectrl.VideoCompressors;

      // check the index of a video compressor
      int i = compressors.IndexOf(capturectrl.VideoCompressors.Mpeg2);

      Compressor cmp = null;
      if (i > -1)
         // access the compressor via the collection indexer
         cmp = compressors[i];

      // check if the collection contains this input 
      // (it should we just got it with IndexOf above)
      if (compressors.Contains(cmp))
      {
         // set the result to what we expect
         _result = true;
      }
   }
   catch (Exception)
   {
      _result = false;
   }
}

Remarks

This method searched the underlying item collection to locate the desired item.

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