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

Artículo
03/15/2016

Obtiene una colección de todos los objetos de Term de T:Microsoft.SharePoint.TaxonomyTermSets todos en esta TermStore que el usuario actual tiene permisos para leer, que tienen 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 TermStore
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

Indica si búsqueda de propiedad personalizada nombres y los valores que comienzan con las cadenas especificadas, o buscar aquellos que exactamente coinciden con las cadenas especificadas.

resultCollectionSize
Tipo: System.Int32

Indica el número máximo de objetos de término para incluir en el objeto devuelto TermCollection .

trimUnavailable
Tipo: System.Boolean

Un valor booleano que indica si se va a recortar términos con Term.IsAvailableForTagging establecido en false.

Valor devuelto

Tipo: Microsoft.SharePoint.Taxonomy.TermCollection
Una colección de todos los objetos de Term , de todos los objetos de TermSet de este TermStore que el usuario actual tiene permisos para leer, que tienen una propiedad personalizada a partir de o que coinciden con el nombre de propiedad especificado y el valor de la propiedad especificada.

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 un carácter no válido '\t', '\n' o ambos.
ArgumentOutOfRangeException	El resultCollectionSize no es válido. Debe ser mayor que 0.

Comentarios

Si se establece trimUnavailable en true términos que tienen Term.IsAvailableForTagging establecido en false se eliminarán de los resultados; de lo contrario, se devolverá todos los términos coincidentes independientemente de su valor de Term.IsAvailableForTagging . El customPropertyName no puede ser nulo ni estar vacío 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 está vacía y no debe superar los 255 caracteres de longitud.Tampoco puede contener los caracteres no válidos de \t o \n. El valor de resultCollectionSize debe ser mayor que 0. La búsqueda distingue entre mayúsculas y minúsculas. El número máximo de resultados de esta búsqueda está restringido por el parámetro resultCollectionSize . Se recomienda que todos los cambios pendientes se confirmarán en la base de datos con CommitAll() antes de realizar esta búsqueda para obtener resultados más precisos.