SharePoint List Booster Features

Transcription

1 SharePoint List Booster Features

2 Contents Overview... 5 Supported Environment... 5 User Interface... 5 Disabling List Booster, Hiding List Booster Menu and Disabling Cross Page Queries for specific List or Document Library... 6 Column Resizing... 7 Booster Pagination Control... 7 Show Quick Edit link for Documents Library... 9 Table Styles Column Styles Truncate Long Text Conditional Formatting Rules Text Rules Text Contains Text Doesn t Contain Text is Equal Text Starts With Text Ends With Cell is Empty Cell is Not Empty Date Rules Date Is Date Is Before Date Is After Comparison Rules Greater Than Greater Than or Equal To Less Than Less Than or Equal To SharePoint List Booster Features Page 2 of 46

3 Is Equal To Is Not Equal Is Between Is Not Between Rank Rules Top Bottom Top % Bottom % Digits Average Rules Equals Average Above Average Below Average Equals or Above Average Equals or Below Average Column-type-based Rules Contains Current User Formatting Rules Priority, Reorder and Styles Merge Stop If True Apply Styling to the Whole Row Process Values from All Pages Progress Bars Progress Bars Settings Indicator shape Range Color Conditions Freeze Header Print List Advanced Column Settings Column Visibility Settings Collapse Tasks Hierarchy Custom Styles and Styles Publish SharePoint List Booster Features Page 3 of 46

4 Publishing or Resetting Custom Styles Publish Styles Reset Styles Clear All Styling Viewers Permissions List Booster Settings Ribbon Button Highlight Columns List Hovered Row in View Settings Performance / Rendering Time When Working with Large Lists About Window Export List Booster Styles with Site\List Templates (PRO Edition) How Booster Settings and Styles Are Stored? SharePoint Themes Limitations and Restrictions SharePoint List Booster Features Page 4 of 46

5 Overview This document describes main features and functionality of SharePoint List Booster add-in. Supported Environment List Booster works with SharePoint 2013, SharePoint 2016 and SharePoint Online for both Lists and Document Libraries (except Modern Experience for O365 Lists and Document Libraries). Each List or Document Library View with Default style can be configured separately. List Booster supports all modern desktop browsers: 1. Internet Explorer version 9 or higher (Windows) 2. Microsoft Edge (Windows) 3. Google Chrome (Windows & Mac) 4. Mozilla Firefox (Windows & Mac) 5. Safari (Mac) User Interface List Booster icon appears above the list view grid. The add-in appears in inactive mode by default: User has to click List Booster button to enter active (design) mode (where user can configure the look of the view): This makes main features available for the user: SharePoint List Booster Features Page 5 of 46

6 Disabling List Booster, Hiding List Booster Menu and Disabling Cross Page Queries for specific List or Document Library User can disable/enable List Booster plugin, hide/show List Booster menu (styles will remain) or disable/enable Cross Page Queries for the specific list (Document Library). To do that user needs to open the List (Document Library) settings and click on List Booster Settings link in General Settings group. These settings are also available through List Booster Settings Ribbon Button (see List Booster Settings Ribbon Button section of the document). And then uncheck one of three check boxes in the dialog: - Enable styling check box allows to enable/disable the plugin - Show Booster menu allows to show/hide List Booster menu SharePoint List Booster Features Page 6 of 46

7 - Enable Cross Page Queries allows to enable/disable Booster Paging and Process values from all pages in Conditional Formatting. This allows to increase the rendering performance for the list with large amount of items/pages. Column Resizing User can change columns widths by dragging or double-clicking on resize icon to the right side of list table header cells: User can t resize system columns (such as column with More Options menu, item select column and others). Column width cannot be less than a width of the longest word in the column. Booster Pagination Control List Booster plugin provides more user-friendly pagination control that replaces the default one at the bottom of the view and also adds one on top of the view. Main features: 1. User can see total pages count 2. User can navigate to the first/last page 3. User can navigate to the next/previous page Booster Pagination Control visibility can be configured by clicking settings button Use "Booster" paging. Makes it easy to navigate between pages. check box. and checking/unchecking SharePoint List Booster Features Page 7 of 46

8 SharePoint List Booster Features Page 8 of 46

9 Show Quick Edit link for Documents Library By default List Booster plugin adds Edit this library link to Document Libraries to allow users switch to Quick Edit mode more conveniently. SharePoint 2013 link user interface SharePoint Online user interface User can configure Quick Edit link visibility by clicking settings button Edit link check box. and checking/unchecking Use Quick SharePoint List Booster Features Page 9 of 46

10 Table Styles User can select one of the predefined table styles color schemes (similar to Word and Excel) to change the look of list (document library) view rows. To do that user needs to click on Table Styles button and select one of the templates in the opened dialog (template can be selected by double-clicking or by clicking the template and pressing OK button) User can also clear table style color scheme by clicking Clear table style link in the same dialog. SharePoint List Booster Features Page 10 of 46

11 Column Styles User can open Column styling dialog by hovering over column s header cell and clicking on showed edit button: On the dialog tab named Static formatting user can select visual styles (font style, text alignment, text color, text case, background, wrapping options) of column s header and content separately. SharePoint List Booster Features Page 11 of 46

12 Truncate Long Text For Multiline Plain Text columns user can also truncate long text: If the setting is selected the text in the columns will be truncated with at the end. Click on the cell will show full text. Additional click will truncate the text back (in the image below the first text is not too long so it has not been truncated, the second is long and been truncated). SharePoint List Booster Features Page 12 of 46

13 Conditional Formatting User can open Column styling dialog by hovering over column s header cell and clicking on showed edit button: On the dialog tab named Conditional formatting user can add conditional rules and styles that will be applied to the cell if it meets the rule. To add new rule user has to click on + Add new rule link. The new rule will be added to the bottom of the list of rules. User also can remove all rules by clicking - Remove all rules link. SharePoint List Booster Features Page 13 of 46

14 Rules List Booster Conditional Formatting contains variety of rules that can be applied to format specific cells in a column. Text Rules Text rules are used to format cells that contain or do not contain entered text. User can select to ignore case or not. Rule user interface example. Text Contains Text in a cell contains entered string. Text Doesn t Contain Text in a cell doesn t contain entered string. Text is Equal Cell contains exactly the same string as entered. Text Starts With Text in a cell starts with a specific string. Text Ends With Text in a cell ends with a specific string. Cell is Empty Cell doesn t contain any text. Cell is Not Empty Cell contains any text. Date Rules These rules are used to check if a date in a cell is equal to entered date or within predefined interval. Rule user interface example. SharePoint List Booster Features Page 14 of 46

15 Date Is Cell s value is Equal to today s date Equal to tomorrow s date Equal to yesterday s date Within the past week (calendar week, not just 7 days before today) Within this week (calendar week) Within the next week (calendar week, not just 7 days after today) Within the past month Within this month Within the next month Within the past year Within this year Within the next year Equal to the entered date Date Is Before Cell s value is: Before today s date Before tomorrow s date Before yesterday s date Before the past week (calendar week, not just 7 days before today) Before this week (calendar week) Before next week (calendar week, not just 7 days after today) Before past month Before this month Before next month Before past year Before this year Before next year Before the entered date Date Is After Cell s value is: After today s date After tomorrow s date After yesterday s date After past week (calendar week, not just 7 days before today) After this week (calendar week) After next week (calendar week, not just 7 days after today) After past month After this month SharePoint List Booster Features Page 15 of 46

16 After next month After past year After this year After next year After the entered date Comparison Rules These rules are used to compare entered value (interval) with a cell s value. If a cell contains string value then string comparison rules are used: string A is less than string B if A precedes B in ascending sort order. Single value example. Interval example Greater Than Entered value is greater than cell s value. Greater Than or Equal To Entered value is greater than or equal to cell s value. Less Than Entered value is less than cell s value. Less Than or Equal To Entered value is less than or equal to cell s value. Is Equal To Entered value is equal to cell s value. Is Not Equal Entered value is not equal to cell s value. SharePoint List Booster Features Page 16 of 46

17 Is Between Cell s value falls in entered interval. Is Not Between Cell s value doesn t fall in entered interval. Rank Rules These rules are used to format maximum and minimum numeric values of a column on the current page or in entire view (base on Process values from all pages check box see below) of the list (document library) view. Rule user interface example. Top Formats a cell if its value is one of N (entered integer number) highest values. Bottom Formats a cell if its value is one of N (entered integer number) lowest values. Top % Formats a cell if its value is one of N (entered integer number) % of highest values. Bottom % Formats a cell if its value is one of N (entered integer number) % of lowest values. Digits Average Rules These rules are used to format cells relatively to arithmetic mean of all numeric values of a column on the current page or in entire view (base on Process values from all pages check box see below) of the list (document library) view. Rule user interface example. Equals Average Cell s value is equal to the arithmetic mean of numeric values. SharePoint List Booster Features Page 17 of 46

18 Above Average Cell s value is greater than the arithmetic mean of numeric values. Below Average Cell s value is less than the arithmetic mean of numeric values. Equals or Above Average Cell s value is greater than or equal to the arithmetic mean of numeric values. Equals or Below Average Cell s value is less than or equal to the arithmetic mean of numeric values. Column-type-based Rules These rules are based on the type of current column. Contains Current User The rule can be applied to Person or Group column and highlights the cells with current (logged in) user in it. Formatting User can configure formatting for each rule separately. The formatting is applied to a cell if the rule s condition is true for the value of the cell. Here are the options of formatting that can be changed. Background Font color Text alignment (vertical and horizontal) Text decoration (bold, italic, underline) Hiding cell s value do not display the text in the cell Add Indicator to the cell user can add predefined icon to the cell, configure its color and horizontal alignment (vertical alignment is the same as for text in a cell) Indicator icons SharePoint List Booster Features Page 18 of 46

19 Rules Priority, Reorder and Styles Merge Rules are applied one by one from top to the bottom of the rules list. Styles configured for the rule, which is higher in the rules list, have higher priority than styles of a lower rule. It means that if user adds two rules and wants to change cell s background in each of them, the background of a cell will be set to one that is configured for the top rule. User can change rules order, which changes the priority. To do that user needs to click up or down arrow button, which is located to the left from the rule. If cell s value meets several rules their styles are merged based on priority. For example, user set two rules as shown below. SharePoint List Booster Features Page 19 of 46

20 The cell has text a better choice. In that case cell s value meets both rules. Thus, a resulting formatting for the cell will be (based on configured styles and priority): Blue background, white font color, text alignment left, bold, light green check indicator aligned to the right. If user changes these rules order then background will change to dark red. Stop If True User can stop rules evaluation at a specific rule by checking the Stop if true check box. It means that if a cell s value is true then the add-in stops checking it. Styles from the following rules will not be applied to the cell. Stop if true check box is taken into consideration only if cell s value meets the rule where the check box is set. Apply Styling to the Whole Row User can apply rules styles to the whole row instead of a cell in a column. This functionality doesn t apply to hiding cell s value and adding indicator: these options are always applied to a cell. To do this user has to check Style all row by column s cell s value check box at the bottom of Conditional Formatting tab. SharePoint List Booster Features Page 20 of 46

21 This option could be selected for a single column only. If user enables it for another column, previous selection will be disabled (if user is in personal mode and previous selection is in public mode then public mode selection will be ignored). Process Values from All Pages User can choose whether to use only current page values or all pages values for rank and average rules. To configure it user needs to check/uncheck Process values from all pages check box at the bottom of Conditional Formatting tab (the check box is enabled only if there is at least one rank or average rule in the list of rules). SharePoint List Booster Features Page 21 of 46

22 Progress Bars User can select to display progress bars instead of values for Number, Currency and Date and Time columns. Progress bars can t be applied to the columns with conditional formatting rules. So the user should select either rules or progress bars. Progress Bars Settings There are several settings user can change to apply progress bar that fits his needs. Indicator shape User can select one of 7 provided shapes 4 linear: SharePoint List Booster Features Page 22 of 46

23 3 radial: Range User can select minimum value, equals to 0% and maximum value, equals to 100%. Values that are less than minimum will be marked as < 0%. Values that are greater than maximum will be marked as > 100%. The range should be based on the values from the column. Color Conditions User can apply several color conditions to the progress bar. It means that progress bar indicator s color will depend on the value in specific list item (as example, low battery charge is usually displayed in red, medium in orange, high in green). User can add a condition by clicking on the color scale ( + button). Tooltip will inform user on the value of the condition. SharePoint List Booster Features Page 23 of 46

24 User can change color of any condition by clicking on color square. Also user can change condition value, color or remove the condition by clicking on : SharePoint List Booster Features Page 24 of 46

25 Freeze Header User can freeze list s header by clicking Freeze Header button in List Booster menu: In that case the header row will be freezed and remain visible during scrolling. The scrolling will be applied to the list body : By default, height of the list is calculated to fit in the page. But user can change it in Freeze Header menu (can be opened by clicking on arrow in Freeze Header button): SharePoint List Booster Features Page 25 of 46

26 Use Public Settings option leads to using the settings that were published by the list administrator. Freeze Header functionality works in Read mode only. In Quick Edit mode user will see standard list header. SharePoint List Booster Features Page 26 of 46

27 Print List User can print current list view (current displayed page of the list) by clicking on Print button on List Booster menu: If user click on printer icon then the list view will be printed with default or published options. User can also modify print options by clicking Print item in Print context menu (displayed when user clicks menu arrow in front of printer icon): Selecting the menu item will open Print settings dialog where user can select what columns should be printed: Clicking on Print (similar to clicking on printer icon) will show standard print dialog but the result of the printing will be not the whole page but the list only. Print context menu is always available for list administrators. Viewers access to it is based on the selected permissions (see Viewers Permissions) Important information SharePoint List Booster Features Page 27 of 46

28 User needs to enable printing background colors and images in browser settings to display selected styles and conditional formatting rules. To do so In Internet Explorer Go to File -> Page Setup Check Print Background Colors and Images checkbox In Chrome Click on Menu button ( ) -> Print... or on List Booster Print button Expand More settings section Check Background graphics checkbox SharePoint List Booster Features Page 28 of 46

29 In Mozilla Firefox Click on Menu button ( ) -> Print Click on Page Setup button Check Print Background (colors & images) checkbox In Safari Go to File -> Print Check Print Backgrounds checkbox SharePoint List Booster Features Page 29 of 46

30 Microsoft Edge doesn t support printing of background colors and images. SharePoint List Booster Features Page 30 of 46

31 Advanced Column Settings Column Visibility Settings User can select users and SharePoint groups who will see the column in this view. If current user is not selected (or is not in one of selected groups) he won t see the column as well. Visibility settings are available in Public Mode only. SharePoint List Booster Features Page 31 of 46

32 Collapse Tasks Hierarchy By default, SharePoint shows Tasks hierarchy in expanded state: User can change this default behavior by clicking settings button hierarchy by default (will take effect after page refresh) check box. and checking/unchecking Collapse tasks' SharePoint List Booster Features Page 32 of 46

33 Custom Styles and Styles Publish When user applies Booster styling all the changes are visible for this user only. This situation may be interpreted as Draft or Custom styling. As soon as user has applied all the changes he wanted, he can publish styles to make them visible to other users as well. Note: only users with Manage Lists permissions level can publish styles. For all other users styles will be stored for current browser only. Publishing or Resetting Custom Styles As soon as a user applies some styling to the list List Booster will show a notification label informing that there are custom styles and also an action link: Publish or reset for a user with Manage Lists permissions level Reset for a user without Manage Lists permissions level Clicking on the action link will open a dialog where user can select either to publish styles or reset (reset only for a user without Manage Lists permissions level). SharePoint List Booster Features Page 33 of 46

34 Publish Styles If a user wants to publish custom styles he will need to click on Publish styles link in the dialog. After that List Booster will perform the publishing and will show a confirmation message when styles are published: Reset Styles If a user wants to reset custom styles he will need to click on Reset styles link in the dialog. After that List Booster will ask user to select what custom styles to reset: Columns styles styles that were applied to any column through the Column Settings dialog (static formatting, conditional formatting, advanced settings) Columns widths any custom columns widths Table styles custom table styling Freeze header options customized freeze header compared to published state Print settings custom print settings If user clicks Reset selected List Booster will clear selected types of custom modifications and refresh the page. If user clicks Cancel the dialog will be closed without any changes. SharePoint List Booster Features Page 34 of 46

35 Clear All Styling User can clear configured styling by clicking Clear all styling link : to clear personal styles, public style or both:. Administrator has an option User who has no Edit Permissions is able to clear personal styles only: SharePoint List Booster Features Page 35 of 46

36 Viewers Permissions Administrators can configure what Booster styling is available for the Viewers (users who have no Edit permissions). To do that administrator needs to click on Click to learn more link configure viewers permissions: and check/uncheck check boxes to SharePoint List Booster Features Page 36 of 46

37 List Booster Settings Ribbon Button List Booster Settings Ribbon Button is located in List (Library) tab under Settings group and is available for users with Manage Lists permissions level. In O365 New List Experience button is located in Actions stripe. Clicking on the button shows the dialog that allows user to disable List Booster, hide List Booster Menu and disable Cross Page Queries for specific List or Document Library (see Disabling List Booster, Hiding List Booster Menu and Disabling Cross Page Queries for specific List or Document Library section of the document). For O365 list and libraries the dialog also allows to switch List Experience between New and Classic. List Booster works in Classic Experience only. Dialog for on premise version: SharePoint List Booster Features Page 37 of 46

38 Dialog for O365 version: SharePoint List Booster Features Page 38 of 46

39 Highlight Columns List Hovered Row in View Settings List Booster adds a highlight to Columns List in View Settings. It allows users to select and reorder view columns more effectively SharePoint List Booster Features Page 39 of 46

40 Performance / Rendering Time When Working with Large Lists Because of the SharePoint limitations List Booster has to query all items in the view in order to provide List Booster Paging capabilities. The same happens when using Process items from all pages feature in conditional formatting. This affects the performance of the list rendering for large lists. Consider disabling this functionality by going to the List (Document Library) settings, clicking on List Booster Settings link in General Settings group and unchecking Enable Cross Page Queries option. SharePoint List Booster Features Page 40 of 46

41 About Window About Window can be opened by clicking on About button. The dialog shows Current version of the List Booster Link to EULA document Link to Sharepointalist YouTube channel with How-to videos Link to the current User Guide Link to send a feedback to List Booster support team SharePoint List Booster Features Page 41 of 46

42 Export List Booster Styles with Site\List Templates (PRO Edition) List Booster PRO edition allows users to save configured published styles with site and list templates. It means that if a user applied styles to lists and libraries, saved the site (or a specific list) as a template through standard SharePoint user interface and then created a new site\list based on the template, the new site\list will contain all the List Booster styles and settings. This functionality is enabled by default for all lists and document libraries but user can disable it for a specific list\library. To do that user should Go to List Booster settings (either from List Booster Settings Ribbon Button, or from List Booster Settings link in List settings) Uncheck Enable styles export checkbox Click OK List Booster Settings dialog opened from List Settings: List Booster Settings dialog opened from List Booster Settings Ribbon Button on-premise version: SharePoint List Booster Features Page 42 of 46

43 List Booster Settings dialog opened from List Booster Settings Ribbon Button O365 version: SharePoint List Booster Features Page 43 of 46

44 How Booster Settings and Styles Are Stored? List Booster uses List (Document Library) Property Bag and browser s cookies to store settings and styling: All general settings (Booster visibility, pagination visibility, and viewers permissions) are stored in Property Bag. Public styles are stored in Property Bag. Administrators personal styles are stored in Property Bag. Viewers personal styles are stored in browser s cookies (because Viewers have no access to modify Property Bag). SharePoint List Booster Features Page 44 of 46

45 SharePoint Themes List Booster plugin supports SharePoint themes and changes its user interface based on selected look of SharePoint site. SharePoint List Booster Features Page 45 of 46

46 Limitations and Restrictions There are some know limitations that are described below: 1. List Booster doesn t work in Internet Explorer 8 and lower 2. List Booster doesn t work with List View Styles other than Default 3. List Booster is disabled on User Information List 4. Conditional formatting and Progress bars can work incorrectly with custom fields and custom rendering 5. Conditional Formatting doesn t work in Views with grouping 6. List Booster Paging doesn t work in Views with grouping 7. Freeze Header feature doesn t work in Quick Edit mode 8. Users can t reset personal styles set by other users 9. Clear all styling and viewers permissions work for current view only 10. List Booster doesn t work in O365 New List Experience (Modern List Experience) 11. List Booster may not work on External Lists SharePoint List Booster Features Page 46 of 46