FilterSelectorPanel MembersA Sandcastle Documented Class Library

The FilterSelectorPanel type exposes the following members.
Constructors

  NameDescription
Private methodStatic memberFilterSelectorPanel
Public methodFilterSelectorPanel
Initializes a new instance of the FilterSelectorPanel class
Back to Top
Methods

  NameDescription
Protected methodbtnFolderLink_Click
A folder link has been clicked.
Protected methodbtnIcon_Click
Icon click event handler.
Private methodBuildForm
Builds the filter listing form from the list of loaded entries.
Public methodClearCache
Clears data out of the global cache.
Public methodClickEntryWithId
Performs a click on the entry with the id.
Public methodFindEntryWithId
Returns the entry with the given id.
Public methodForceRefresh
Forces a reloading of the icon grid.
Public methodGetCurrentFolder
Returns information about the current folder.
Public methodGetCurrentFolderEntryId
Returns the entry id for the current selected folder. This is the primary key value of the folder in the FILTER_FOLDERS table. For the root folder a "0" is returned.
Public methodGetCurrentFolderObj
Returns the P4s3ImageButton object tied to the current folder. This object contains more information about the folder.
Public methodGetFolderChainList
Returns a list of the current folder chain.
Public methodGetFolderList
Returns a list of folders for the given user id.
Public methodGetSelectedItems
Returns an array of selected items.
Public methodGetSelectedItemsBulletedList
Returns the selected items as a bulleted list.
Public methodGetSelectedItemsCount
Returns the currently selected items count.
Public methodGetTotalItemsCount
Returns the number of items in the current folder.
Private methodLoadFilters
Loads the filters that are in the target directory from the full list of filters.
Private methodLoadFolders
Loads the fodlers that are in the current directory from the full list of folders.
Protected methodOnChooseIcon
Choose icon event fires here.
Protected methodOnErrorEncountered
Sends a message back to the owner. Doesn't necessarily have to be an error.
Protected methodOnFiltersLoaded
Event that fires when all filters have been loaded.
Protected methodOnFolderChanged
Fires an event if the current folder changes.
Public methodOpenFolder(String)
Opens folder for the given key.
Public methodOpenFolder(FilterSelectorPanelEntry)
Opens the specified folder.
Private methodOpenRootFolder
Opens the root folder.
Protected methodPage_Init
Standard Page_Init method, loads dynamic controls.
Protected methodPage_Load
Standard Page_Load method.
Private methodPrepForm
Prepares the form from a blank state and adds all the filters/folders for the current folder.
Private methodPrepSvc
Private methodRefreshList
Refreshes the dynamic asp controls from the Http post back. Currently not used as there are no form fields to sync.
Public methodSelectAll
Selects all the icons in the current folder, including/excluding folders as specified.
Public methodSelectEntryWithId
Selects an entry with the id.
Private methodSelectIcon
Performs a selection on an icon.
Public methodToggleEntryWithId
Toggles an entry with the id.
Private methodToggleIcon
Toggles an icon selection.
Public methodUnselectAll
Unselects all selected items.
Public methodUnselectEntryWithId
Unselects an entry with the id.
Private methodUnselectIcon
Unselects an icon.
Public methodUpdateMode
Updates the PanelMode and does some cleanup work.
Public methodUpdateSort
Updates the PanelSort on all objects and does some cleanup work.
Back to Top
Fields

  NameDescription
Private fieldcontrolsKey
Shortcut key for referenceing the controls Dictionary stored in the Session.
Private fieldcurrentFolder
Holds the currently selected folder.
Private fielddefaultIcon
Holds a reference to a default icon image in case the selected one does not exist.
Private fieldfoldersKey
Shortcut key for referencing the folder list.
Private fieldiconsKey
Shortcut key for referenceing the selectedIcons Dictionary stored in the session.
Private fieldkey
Web service secret key.
Public fieldStatic memberMAX_FILTERS
Controls the maximum number of filters you can open at once.
Public fieldStatic memberMAX_NAME_LENGTH
Controls the maximum length of the filter or folder name to show before adding ellipses.
Private fieldpChoiceMode
Internal variable that holds the current ChoiceMode.
Private fieldpColCount
Internal variable representing the column count.
Private fieldpPanelMode
Internal veriable that holds the current PanelMode.
Private fieldpPanelSort
Internal variable that holds the current PanelSort.
Private fieldpWidth
Internal private width value used for setting the column width.
Private fieldselectedIcon
Image button the represents the selected icon.
Private fieldsessionPrefix
Local session prefix value.
Private fieldsvc
Web service client reference.
Back to Top
Properties

  NameDescription
Public propertyChoiceMode
Property for setting the ChoiceMode.
Public propertyColCount
Controls how many columns of icons this control draws.
Public propertyPanelMode
Property for setting the PanelMode.
Public propertyPanelSort
Property for setting the PanelSort.
Public propertyWidth
Public width values for setting the column width.
Back to Top
Events

  NameDescription
Public eventChooseIcon
Event that fires when an icon gets selected.
Public eventErrorEncountered
Event that fires when an error has occured. Designed to be used for logic and exception handling errors. Can pass them up to the owner.
Public eventFiltersLoaded
Event that fires when the filter data is loaded.
Public eventFolderChanged
Event that fires whenever the current folder changes.
Back to Top
See Also