Documentation Center

Best Practices

Following best practices when creating a new handler will help you to avoid the common pitfalls.

  • Use ResolveIds to resolve ids into labels. Try to resolve the tags as quickly as possible to provide better user experience.
  • Use RetrieveTags to provide the tags for autosuggest mode. Since autosuggest shows limited number of tags, respect the value of MaxTagsToReturn parameter to avoid passing too much data over the wire.
  • Use RetrieveTagStructure to provide tags and relations for tree mode. Since the complete tree is passed at once and rendered in UI, try to limit the number of tags returned within the tree to avoid passing too much data over the wire and poor UI performance.
  • Use the FieldsFilter to limit the number of tags to be returned. For the same reason, always use the FieldsFilter value to limit the result set.
  • Avoid circular references in the tree. There is no limitation on the API level against passing the circular references, but the UI will not allow you to expand the circular reference to avoid performance issues.
  • Take the full responsibility for building the tree. UI controls show the tree exactly the way it is created in the handler.