(String, String, StringMatchOption, Int32, Boolean) del método TermSet.GetTermsWithCustomProperty

Artículo
03/15/2016

Obtiene una colección de objetos Term con una propiedad personalizada a partir de o que coinciden con el nombre de propiedad proporcionado y el valor de la propiedad proporcionada.

Espacio de nombres: Microsoft.SharePoint.Taxonomy
Ensamblado: Microsoft.SharePoint.Taxonomy (en Microsoft.SharePoint.Taxonomy.dll)

Sintaxis

'Declaración
Public Function GetTermsWithCustomProperty ( _
    customPropertyName As String, _
    customPropertyValue As String, _
    stringMatchOption As StringMatchOption, _
    resultCollectionSize As Integer, _
    trimUnavailable As Boolean _
) As TermCollection
'Uso
Dim instance As TermSet
Dim customPropertyName As String
Dim customPropertyValue As String
Dim stringMatchOption As StringMatchOption
Dim resultCollectionSize As Integer
Dim trimUnavailable As Boolean
Dim returnValue As TermCollection

returnValue = instance.GetTermsWithCustomProperty(customPropertyName, _
    customPropertyValue, stringMatchOption, _
    resultCollectionSize, trimUnavailable)

public TermCollection GetTermsWithCustomProperty(
    string customPropertyName,
    string customPropertyValue,
    StringMatchOption stringMatchOption,
    int resultCollectionSize,
    bool trimUnavailable
)

Parámetros

customPropertyName
Tipo: System.String

El nombre de propiedad personalizada

customPropertyValue
Tipo: System.String

El valor de la propiedad personalizada

stringMatchOption
Tipo: Microsoft.SharePoint.Taxonomy.StringMatchOption

Si desea buscar los nombres de propiedad personalizada y los valores que comienzan con las cadenas especificadas o busque aquellos que coincidan exactamente con las cadenas especificadas.

resultCollectionSize
Tipo: System.Int32

El número máximo de objetos de Term para incluir en el objeto devuelto TermCollection .

trimUnavailable
Tipo: System.Boolean

Un valor booleano que indica si se va a recortar objetos Term que tienen la propiedad IsAvailableForTagging establecida en false.

Valor devuelto

Tipo: Microsoft.SharePoint.Taxonomy.TermCollection
una colección de objetos Term con una propiedad personalizada a partir de o que coinciden con el nombre de propiedad proporcionado y el valor de la propiedad proporcionada.

Excepciones

Excepción	Condición
ArgumentNullException	El customPropertyName no puede ser una referencia null (Nothing en Visual Basic) o estar vacío.
ArgumentException	El valor de customPropertyName no es válido. Probablemente contiene caracteres no válidos o es demasiado largo.
ArgumentNullException	El customPropertyValue no puede ser una referencia null (Nothing en Visual Basic) o estar vacío.
ArgumentException	El valor de customPropertyValue no es válido. Supera la longitud máxima permitida 255.
ArgumentException	El valor de customPropertyValue no es válido. Contiene invalidcharacter \t, \no ambos.
ArgumentOutOfRangeException	El resultCollectionSize no es válido. Debe ser mayor que 0.

Comentarios

Si trimUnavailable es true, los objetos Term con la propiedad IsAvailableForTagging establecida en false se eliminarán de los resultados; de lo contrario, se devolverá todos los términos coincidentes independientemente de su valor de la propiedad IsAvailableForTagging .El customPropertyName no puede ser una referencia null (Nothing en Visual Basic) o vacía y no debe superar los 255 caracteres de longitud.Tampoco puede contener cualquiera de los siguientes caracteres no válidos: ;"<>|&tab.

El customPropertyValue no puede ser una referencia null (Nothing en Visual Basic) o vacía y no debe superar los 255 caracteres de longitud. Tampoco puede contener cualquiera de los caracteres no válidos de \t o \n. El valor de resultCollectionSize debe ser mayor que 0, la búsqueda distingue mayúsculas de minúsculas. El número máximo de resultados de esta búsqueda es restrictedby el parámetro resultCollectionSize . Para obtener resultados más precisos, Microsoft recomienda utilizar el método CommitAll() para confirmar los resultados de la base de datos antes de realizar esta búsqueda.