In This Topic ▼

Item Property

Summary

Gets or sets the TargetFormat item with the specified name.

Syntax

C++/CLI

public TargetFormat Item( 
   string name 
) { get; set; }

public: 
property TargetFormat^ Item { 
   TargetFormat^ get(String^ name); 
   void set (String^ name, TargetFormat^ ); 
}

Parameters

name
The string name of the item to get or set.

Property Value

The TargetFormat item with the specified name.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
System.NullReferenceException	The exception that is thrown when there is an attempt to dereference a null object reference.

Remarks

This property allows access to a specific item in the collection by using the following syntax: myCollection [index]. The C# language uses the this keyword to define the indexers instead of implementing the Item property. VB implements Item as a default property, which provides the same indexing functionality. An application can use this method to find a specific target format. If the method fails, an error is raised. For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.Multimedia; 
using LeadtoolsMultimediaExamples.Fixtures; 
 
 
public bool _result = false; 
public CaptureCtrlForm _form = new CaptureCtrlForm(); 
 
public void IndexContainsExample() 
{ 
   // reference the capture control 
   CaptureCtrl capturectrl = _form.CaptureCtrl; 
 
   try 
   { 
      // set an audio device first.  use your audio device's name here 
      if (capturectrl.AudioDevices["USB"] == null) 
         throw new Exception("No USB audio device available"); 
 
      capturectrl.AudioDevices["USB"].Selected = true; 
 
      // reference the target formats object 
      TargetFormats formats = capturectrl.TargetFormats; 
 
      // check the index using a name string 
      int i = formats.IndexOf("WAVE"); 
 
      // or get a target format directly, using a TargetFormatType enum 
      TargetFormat mpeg1 = formats[TargetFormatType.MPEG1Audio]; 
 
      // access the format via the collection indexer 
      TargetFormat af = formats[i]; 
 
      // check whether the collection contains this format  
      // (it should we just got it with IndexOf above) 
      if (formats.Contains(af) && formats.Contains(mpeg1)) 
      { 
         // set the result to what we expect 
         _result = true; 
      } 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Requirements

Target Platforms

Reference

TargetFormats Class

TargetFormats Members

Overload List

Download our FREE evaluation

Help Version 22.0.2022.12.7

Leadtools.Multimedia Assembly

Introduction

Getting Started

Namespaces

Leadtools.Multimedia Namespace

Leadtools.Multimedia.Common Namespace

Assemblies