Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

SpaceClaim Add-in Style Guide FEBRUARY 2010 SPACECLAIM ADD-IN STYLE GUIDE 1. IN

SpaceClaim Add-in Style Guide FEBRUARY 2010 SPACECLAIM ADD-IN STYLE GUIDE 1. INTRODUCTION This document contains requirements and recommendations for developing user interface elements for SpaceClaim add-ins using the SpaceClaim API. These guidelines should be used in addition to the 2007 Microsoft Office System User Interface Design Guidelines, which you can find at http://msdn.microsoft.com/officeui . TABLE OF CONTENTS 1.0 Customizing the SpaceClaim UI for add-ins .........................1 2.0 Workflow ..................................................................................2 Interactive workflow steps .............................................................................. 2 Auto-complete workflow steps ....................................................................... 3 Manual complete workflow steps ................................................................... 3 Immediate action workflow steps ................................................................... 3 Selection ........................................................................................................ 4 Preview .......................................................................................................... 4 Dialog launcher .............................................................................................. 4 3.0 Tabs and groups .....................................................................5 Organization ................................................................................................... 5 Text labels ...................................................................................................... 5 4.0 Controls ...................................................................................6 Types of controls available ............................................................................ 6 Layout ............................................................................................................ 7 Tooltips .......................................................................................................... 7 Progress bars ................................................................................................. 8 Active vs. inactive controls ............................................................................. 8 5.0 Other UI elements ...................................................................9 SPACECLAIM ADD-IN STYLE GUIDE Options panel ................................................................................................. 9 Tool guides .................................................................................................... 9 Dialog boxes ................................................................................................ 10 Mini-toolbar .................................................................................................. 10 Cursors ........................................................................................................ 10 Errors and warnings ..................................................................................... 11 Application menu ......................................................................................... 11 Context menu ............................................................................................... 12 6.0 Icons ....................................................................................... 13 Icon sizes ..................................................................................................... 13 File formats .................................................................................................. 13 Colors ........................................................................................................... 13 Common icon elements ............................................................................... 13 3D orientation and shading .......................................................................... 14 Adobe Illustrator files ................................................................................... 14 SPACECLAIM ADD-IN STYLE GUIDE 1 1.0 CUSTOMIZING THE SPACECLAIM UI FOR ADD-INS Your SpaceClaim add-in can include • New tabs, groups, and controls in the Ribbon. • Buttons to the application menu. • Entries to the context (right-click) menu. • Status bar text. • Messages that are written to the message log. • Modal or modeless pop-up forms. The SpaceClaim UI SPACECLAIM ADD-IN STYLE GUIDE 2 2.0 WORKFLOW Before you start on your add-in tool, you should consider its workflow. There are four types of workflow: 1. Interactive (Pull, Move, sketch tools, etc.): This workflow is used when the user can drag an object to make a change. 2. Auto-complete (Combine, Split Solid, Shell, etc.): This workflow is used when you can determine that the operation should be applied based on the user's selection, and when the change doesn't require dragging. 3. Manual complete (Prepare>Midsurface, Prepare>Volume, etc.): This workflow is used when you can't determine when the user is ready to apply the operation based on their selection, and when the command doesn't require dragging. Note Tool guides cannot yet be created with the API, so the Complete button would have to be located in the Ribbon. 4. Immediate action (Fill, Plane, Axis, etc.): This workflow is used when the user selects an object and then clicks the button. The action is applied immediately, without any user interaction. The type of tool you create depends on the workflow that is required for the tool. Use the following sections to determine which type of workflow to create for your tool. Interactive workflow steps These tools show a preview and complete in real time. This approach should be used whenever possible. 1. Click the tool in the Ribbon (e.g., click Pull). 2. Select the object or objects you want to work with (e.g., click on a surface that you want to extrude). This is the primary selection. 3. (Optional) Use a tool guide or hold Alt to select secondary objects (e.g., hold Alt and select an edge to set the pull direction). These objects usually control direction or they anchor the operation. Note Tool guides cannot yet be created with the API. 4. Select options in the Options panel (e.g., click the Both Sides option to pull the surface in both directions at once). SPACECLAIM ADD-IN STYLE GUIDE 3 5. Drag the primary selected object in the Design window to make the change (e.g., drag the surface into a solid). The change can be seen as a preview in real time, and is completed when you finish dragging and release the mouse button. There are alternate workflows for using most tools, such as selecting the objects to work with before starting the tool, but the procedure outlined above is the standard method. Auto-complete workflow steps If a set number of objects are required to define an operation, then you should automatically apply the command when the required objects are selected. 1. Click the tool in the Ribbon (e.g., click Shell). 2. Select options in the Options panel (Shell doesn't have options, but this is when the user would select them). 3. Select the objects required for the operation (e.g., select the face you want removed on the solid you want to shell). The tool instantly applies the change when the correct objects are selected. Manual complete workflow steps Use this method when you cannot determine when the user is ready to apply the command, such as when an indeterminate number of objects need to be selected. The operation is completed with a Complete tool guide. 1. Click the tool in the Ribbon (e.g., click Midsurface on the Prepare tab). 2. Select objects and options, and use tool guides as required (e.g., select one or more face pairs using the Select Faces tool guide, then use the Swap Sides tool guide to swap the sides on two face pairs). The exact order of selection is not easily predictable. 3. Click the Complete tool guide to finish the operation. The design should be temporarily highlighted to show the change after this step whenever possible. Note Tool guides cannot yet be created with the API, so those steps would currently require a different implementation. The steps described here follow the standard SpaceClaim workflow. Immediate action workflow steps Use this method when the user selects one object (or optionally selects multiple objects) and then applies a command. No options or further selection is necessary. 1. Select an object in the Design window or Structure tree (e.g., select the face of a hole in a solid). SPACECLAIM ADD-IN STYLE GUIDE 4 2. Click the tool in the Ribbon (e.g., click Fill). You should only use this workflow for very simple and straightforward operations. If a command requires the user to select multiple objects, then you should probably follow a different workflow. Selection The user should be able to select objects before he or she invokes a tool. Use the following guidelines for selection with your add-in: • You should restrict selection so only appropriate objects can be selected for each step. • The user should always be able to box-select. • Always add a tool guide when a secondary (or Alt-selection) is required for a tool. Note Tool guides cannot yet be created with the API, so those steps would currently require a different implementation. The steps described here follow the standard SpaceClaim workflow. Preview The SpaceClaim API provides facilities for rendering previews. You should provide previews whenever a tool creates or changes geometry based on user selection or options. You can see an example of a preview if you use the Enclosure tool on the Prepare tab. Dialog launcher A tool can launch a dialog box when your add-in requires more sophisticated input than can be captured on the ribbon. For an example, see the Dimension Editor sample add-in. SPACECLAIM ADD-IN STYLE GUIDE 5 3.0 TABS AND GROUPS The Ribbon is the primary menu in the 2007 Microsoft Office UI. The SpaceClaim API provides a simple method to add tabs and controls to the Ribbon. Groups are created by adding an entry to the Ribbon.xml file, and the SpaceClaim API creates and positions the group for you. The following guidelines will help you create tabs and groups that conform to Microsoft standards and blend seamlessly with the SpaceClaim UI. Organization According to the 2007 Microsoft Office UI guidelines, you must organize controls into groups, even when a group only contains one control. Groups should contain controls that are logically related. You should avoid creating a new group for every control, and you should not put too many controls in a single group. The buttons in the sample add-in are organized into small groups of logically related tools. Text labels SpaceClaim follows the Microsoft guidelines for UI capitalization: • Use title style capitalization for the names of tabs, groups, and controls, and for the titles of dialogs and the options panel—capitalize nouns, verbs, adjectives, adverbs, pronouns, and the first and last words. • Use sentence style capitalization for tooltips, elements within dialogs, and options panels—only capitalize the first word and proper nouns. You can find the complete guidelines in the Windows User Experience Interaction Guidelines document at http://msdn.microsoft.com/en-us/library/aa974176.aspx. SPACECLAIM ADD-IN STYLE GUIDE 6 4.0 CONTROLS A control is an object on the Ribbon that the user interacts with to make something happen. It is the equivalent of a command in older UI styles. Like groups, controls are defined in the Ribbon.xml file, and the SpaceClaim API handles their positioning. You have some control over the size and layout of controls. Types of controls available You can create the following types of controls: • Large and small buttons • Submenus of buttons • Check boxes Examples of the controls available uploads/s3/ style-guide 7 .pdf