# Favorite

A **Favorite** object represents a [favorite folder](../../../basic_concepts/the_lister/navigation/favorites). It is retrieved by enumerating or indexing the [Favorites](favorites)object.

| Property Name      | Return Type               | Description                                                                                                                                                                                                                                                                                                                                                          |
| ------------------ | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _\<default value>_ | _string_                  | Returns the name of the favorite folder or sub-folder.                                                                                                                                                                                                                                                                                                               |
| folder             | _bool_                    | <p>Returns <strong>True</strong> if this is a sub-folder, <strong>False</strong> if it's a favorite folder or separator.</p><p>If this object is a sub-folder it also behaves like a <a href="favorites"><strong>Favorites</strong></a> object as well as a <strong>Favorite</strong> object, and can be enumerated and have elements added and removed from it.</p> |
| separator          | _bool_                    | Returns **True** if this is a separator.                                                                                                                                                                                                                                                                                                                             |
| path               | _object:_[**Path**](path) | Returns the path this favorite folder refers to as a [**Path**](path) object.                                                                                                                                                                                                                                                                                        |

| Method// Name// | **Arguments**                                                                          | Return Type | Description                                                                                                                                                                                                                                                                                                                                            |
| --------------- | -------------------------------------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| SetHeading      | \<string:heading>                                                                      | _none_      | <p>If this is a separator (i.e. the <strong>separator</strong> property returns <strong>True</strong>) this lets you make the separator into a heading, or change the heading text.</p><p>Note that changes you make to the list are not saved until you call the <a href="favorites"><strong>Favorites</strong></a><strong>.Save</strong> method.</p> |
| SetName         | \<string:name>                                                                         | _none_      | Changes the name of this favorite folder. Note that changes you make to the list are not saved until you call the [**Favorites**](favorites)**.Save** method.                                                                                                                                                                                          |
| SetPath         | <p>&#x3C;string:path> or<br>&#x3C;object:<a href="path"><strong>Path</strong></a>></p> | _none_      | Changes the path this favorite folder refers to. Note that changes you make to the list are not saved until you call the [**Favorites**](favorites)**.Save** method.                                                                                                                                                                                   |
