CA1043: Use integral or string argument for indexers

 

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

TypeNameUseIntegralOrStringArgumentForIndexers
CheckIdCA1043
CategoryMicrosoft.Design
Breaking ChangeBreaking

A public or protected type contains a public or protected indexer that uses an index type other than System.Int32, System.Int64, System.Object, or System.String.

Indexers, that is, indexed properties, should use integer or string types for the index. These types are typically used for indexing data structures and increase the usability of the library. Use of the Object type should be restricted to those cases where the specific integer or string type cannot be specified at design time. If the design requires other types for the index, reconsider whether the type represents a logical data store. If it does not represent a logical data store, use a method.

To fix a violation of this rule, change the index to an integer or string type, or use a method instead of the indexer.

Suppress a warning from this rule only after carefully considering the need for the nonstandard indexer.

The following example shows an indexer that uses an Int32 index.

Imports System

Namespace DesignLibrary

    Public Class Months

        Private month() As String = {"Jan", "Feb", "..."}

        Default ReadOnly Property Item(index As Integer) As String
            Get
                Return month(index)
            End Get
        End Property

    End Class

End Namespace

CA1023: Indexers should not be multidimensional

CA1024: Use properties where appropriate

Show: