TaxonomySession.GetTermsWithCustomProperty TaxonomySession.GetTermsWithCustomProperty TaxonomySession.GetTermsWithCustomProperty Method

Definition

Overloads

GetTermsWithCustomProperty(String, Boolean) GetTermsWithCustomProperty(String, Boolean) GetTermsWithCustomProperty(String, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name.

GetTermsWithCustomProperty(String, Int32, Boolean) GetTermsWithCustomProperty(String, Int32, Boolean) GetTermsWithCustomProperty(String, Int32, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name.

GetTermsWithCustomProperty(String, String, Boolean) GetTermsWithCustomProperty(String, String, Boolean) GetTermsWithCustomProperty(String, String, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name and the provided property value.

GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name and the property value matching the provided value in the specified way.

GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name and the property value matching the provided value in the specified way.

GetTermsWithCustomProperty(String, Boolean) GetTermsWithCustomProperty(String, Boolean) GetTermsWithCustomProperty(String, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name.

public:
 Microsoft::SharePoint::Taxonomy::TermCollection ^ GetTermsWithCustomProperty(System::String ^ customPropertyName, bool trimUnavailable);
public Microsoft.SharePoint.Taxonomy.TermCollection GetTermsWithCustomProperty (string customPropertyName, bool trimUnavailable);
Public Function GetTermsWithCustomProperty (customPropertyName As String, trimUnavailable As Boolean) As TermCollection
Parameters
customPropertyName
String String String

Property name.

trimUnavailable
Boolean Boolean Boolean

yes if it trims the unavailable Term objects from the result collection; no if it includes the unavailable Term objects in the result collection.

Returns

A collection of Term objects.

Exceptions

Remarks

Only TermSet objects that are not scoped to an SPSite object and TermSet objects that are scoped to current site are searched.

The maximum number of returned Term objects from each TermStore is 100.

The search results are returned directly from the TermStore object. The TermStore object may not be synchronized with changes that have been made but not committed. For best results, call the CommitAll() method or call the RollbackAll() method before calling this method.

GetTermsWithCustomProperty(String, Int32, Boolean) GetTermsWithCustomProperty(String, Int32, Boolean) GetTermsWithCustomProperty(String, Int32, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name.

public:
 Microsoft::SharePoint::Taxonomy::TermCollection ^ GetTermsWithCustomProperty(System::String ^ customPropertyName, int resultCollectionSize, bool trimUnavailable);
public Microsoft.SharePoint.Taxonomy.TermCollection GetTermsWithCustomProperty (string customPropertyName, int resultCollectionSize, bool trimUnavailable);
Public Function GetTermsWithCustomProperty (customPropertyName As String, resultCollectionSize As Integer, trimUnavailable As Boolean) As TermCollection
Parameters
customPropertyName
String String String

Property name.

resultCollectionSize
Int32 Int32 Int32

The maximum number of Term objects to return from each TermStore.

trimUnavailable
Boolean Boolean Boolean

yes if it trims the unavailable Term objects from the result collection; no if it includes the unavailable Term objects in the result collection.

Returns

A collection of Term objects.

Remarks

Only TermSet objects that are not scoped to a SPSite object and TermSet objects that are scoped to current site are searched.

The search results are returned directly from the TermStore object. The TermStore object may not be synchronized with changes that have been made but not committed. For best results, call the CommitAll() method or call the RollbackAll() method before calling this method.

GetTermsWithCustomProperty(String, String, Boolean) GetTermsWithCustomProperty(String, String, Boolean) GetTermsWithCustomProperty(String, String, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name and the provided property value.

public:
 Microsoft::SharePoint::Taxonomy::TermCollection ^ GetTermsWithCustomProperty(System::String ^ customPropertyName, System::String ^ customPropertyValue, bool trimUnavailable);
public Microsoft.SharePoint.Taxonomy.TermCollection GetTermsWithCustomProperty (string customPropertyName, string customPropertyValue, bool trimUnavailable);
Public Function GetTermsWithCustomProperty (customPropertyName As String, customPropertyValue As String, trimUnavailable As Boolean) As TermCollection
Parameters
customPropertyName
String String String

Property name.

customPropertyValue
String String String

Property value.

trimUnavailable
Boolean Boolean Boolean

yes if it trims the unavailable Term objects from the result collection; no if it includes the unavailable Term objects in the result collection.

Returns

A collection of Term objects.

Remarks

Only TermSet objects that are not scoped to an SPSite object and TermSet objects that are scoped to current site are searched.

The maximum number of returned Term objects from each TermStore is 100.

The search results are returned directly from the TermStore object. The TermStore object may not be synchronized with changes that have been made but not committed. For best results, call the CommitAll() method or call the RollbackAll() method before calling this method.

GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name and the property value matching the provided value in the specified way.

public:
 Microsoft::SharePoint::Taxonomy::TermCollection ^ GetTermsWithCustomProperty(System::String ^ customPropertyName, System::String ^ customPropertyValue, Microsoft::SharePoint::Taxonomy::StringMatchOption stringMatchOption, bool trimUnavailable);
public Microsoft.SharePoint.Taxonomy.TermCollection GetTermsWithCustomProperty (string customPropertyName, string customPropertyValue, Microsoft.SharePoint.Taxonomy.StringMatchOption stringMatchOption, bool trimUnavailable);
Parameters
customPropertyName
String String String

Property name.

customPropertyValue
String String String

Property value.

stringMatchOption
StringMatchOption StringMatchOption StringMatchOption

How the property value is matched.

trimUnavailable
Boolean Boolean Boolean

yes if it trims the unavailable Term objects from the result collection; no if it includes the unavailable Term objects in the result collection.

Returns

A collection of Term objects.

Remarks

Only TermSet objects that are not scoped to an SPSite object and TermSet objects that are scoped to current site are searched.

The maximum number of returned Term objects from each TermStore is 100.

The search results are returned directly from the TermStore object. The TermStore object may not be synchronized with changes that have been made but not committed. For best results, call the CommitAll() method or call the RollbackAll() method before calling this method.

GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean) GetTermsWithCustomProperty(String, String, StringMatchOption, Int32, Boolean)

Gets Term objects from all TermStore objects that have a property with the provided property name and the property value matching the provided value in the specified way.

public:
 Microsoft::SharePoint::Taxonomy::TermCollection ^ GetTermsWithCustomProperty(System::String ^ customPropertyName, System::String ^ customPropertyValue, Microsoft::SharePoint::Taxonomy::StringMatchOption stringMatchOption, int resultCollectionSize, bool trimUnavailable);
public Microsoft.SharePoint.Taxonomy.TermCollection GetTermsWithCustomProperty (string customPropertyName, string customPropertyValue, Microsoft.SharePoint.Taxonomy.StringMatchOption stringMatchOption, int resultCollectionSize, bool trimUnavailable);
Parameters
customPropertyName
String String String

Property name.

customPropertyValue
String String String

Property value.

stringMatchOption
StringMatchOption StringMatchOption StringMatchOption

How the property value is matched.

resultCollectionSize
Int32 Int32 Int32

The maximum number of Term objects returned from each TermStore object.

trimUnavailable
Boolean Boolean Boolean

yes if it trims the unavailable Term objects from the result collection; no if it includes the unavailable Term objects in the result collection.

Returns

A collection of Term objects.

Remarks

Only TermSet objects that are not scoped to a site and TermSet objects that are scoped to current site are searched.

The search results are returned directly from the TermStore object. The TermStore object may not be synchronized with changes that have been made but not committed. For best results, call the CommitAll() method or call the RollbackAll() method before calling this method.

Applies to