Skip to content

Latest commit

 

History

History
231 lines (181 loc) · 11.2 KB

README.md

File metadata and controls

231 lines (181 loc) · 11.2 KB

This Add-In is used for marking up Excel files with revisions. There are two common methods of indicating where a revision has changed a drawing that contains a system diagram. The first is the cloud method, were each change is enclosed by a cloud shape. The second method involves placing a triangle with the revision number next to each effected portion of the drawing. The cloud method indicates changes from the most recent revision only, whereas the second method indicates all revisions to the drawing because all of the previous revision circles remain on the drawing. It is written in 3 different versions as a VSTO Add-In in C# and VB.NET as well as a VBA Add-In.

License: MIT Latest Release Github commits (since latest release) GitHub issues


Table of Contents


Install

Instructions for installation of VBA and VSTO versions.

VBA

How to install the VBA version

  1. Download the VBA Add-In file download VBA.
  2. Copy the file to the XLSTART folder on your computer. %AppData%\Microsoft\Excel\XLSTART\
  3. Close all open instances of Excel and then launch Excel. The new ribbon should appear.

VSTO

How to install the VSTO version

  1. Download AnthonyDuguid.pfx And Install At Root Level download Key
  2. Download and run the setup.exe file. download VSTO

Dependencies

Software Dependency Project
Microsoft Visual Studio Solution VSTO
Microsoft Office Developer Tools Solution VSTO
Microsoft Excel Project VBA, VSTO
Visual Basic for Applications Code VBA
Extensible Markup Language (XML) Ribbon VBA, VSTO
Log4Net Error Logging VSTO
Google Icons Ribbon Icons VBA, VSTO
ScreenToGif Read Me VBA, VSTO
Snagit Read Me VBA, VSTO
Badges (Library, Custom, Star/Fork) Read Me VBA, VSTO

Glossary of Terms

Term Meaning
COM Component Object Model (COM) is a binary-interface standard for software components introduced by Microsoft in 1993. It is used to enable inter-process communication and dynamic object creation in a large range of programming languages. COM is the basis for several other Microsoft technologies and frameworks, including OLE, OLE Automation, ActiveX, COM+, DCOM, the Windows shell, DirectX, UMDF and Windows Runtime.
Cloud Refers to the joined arcs that make up a shape
Hatch The use of fine, parallel lines drawn closely together, often rapidly drawn, to create the illusion of shade or texture
VBA Visual Basic for Applications (VBA) is an implementation of Microsoft's event-driven programming language Visual Basic 6 and uses the Visual Basic Runtime Library. However, VBA code normally can only run within a host application, rather than as a standalone program. VBA can, however, control one application from another using OLE Automation. VBA can use, but not create, ActiveX/COM DLLs, and later versions add support for class modules.
VSTO Visual Studio Tools for Office (VSTO) is a set of development tools available in the form of a Visual Studio add-in (project templates) and a runtime that allows Microsoft Office 2003 and later versions of Office applications to host the .NET Framework Common Language Runtime (CLR) to expose their functionality via .NET.
XML Extensible Markup Language (XML) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.The design goals of XML emphasize simplicity, generality, and usability across the Internet. It is a textual data format with strong support via Unicode for different human languages. Although the design of XML focuses on documents, the language is widely used for the representation of arbitrary data structures such as those used in web services.

Functionality

This Excel ribbon is inserted after the “Home” tab when Excel opens. Listed below is the detailed functionality of this application and its components.

Select Markup Color (Group)

Color Palette (Button)

  • Select a color for the Markup shapes

Standard Colors (Dropdown)

  • Select a standard color for the Markup shapes from the list

Update (Button)

  • Update the color for the selected shapes

Insert Revision (Group)

Character (Textbox)

  • This character will appear in the middle of the triangle

Triangle (Button)

  • Insert a revision triangle in the area of the selected cell(s)

Insert Markup (Group)

Cloud (Button)

  • Insert a cloud in the area of the selected cell(s)

Cloud Inverted (Button)

  • Insert an inverted cloud in the area of the selected cell(s)

Cloud & Hatch (Button)

  • Insert a cloud with hatching in the area of the selected cell(s)

Hatch (Button)

  • Insert hatching in the area of the selected cell(s)

Insert Cloud Part (Group)

Left (Button)

  • Insert a cloud part on the Left of the selected cell(s)

Right (Button)

  • Insert a cloud part on the Right of the selected cell(s)

Top (Button)

  • Insert a cloud part on the Top of the selected cell(s)

Bottom (Button)

  • Insert a cloud part on the Bottom of the selected cell(s)

Edit Markup (Group)

Group (Menu)

  • Join objects together to move and format them as if they were a single object

Remove Last (Button)

  • Remove the last shape created

Remove All (Button)

  • Remove all Markup shapes from the active worksheet

Help (Group)

How To… (Button)

  • Opens a webpage of the read me documentation

Report Issue (Button)

  • Opens a page to create a new issue for the product

Add-In Settings (Button)

VSTO
  • Types of VSTO Settings
    • Application Settings
      • These settings can only be changed in the project and need to be redeployed
      • They will appear disabled in the form
    • User Settings
      • These settings can be changed by the end-user
      • They will appear enabled in the form
VBA
  • VBA Settings
    • To add a new setting
      ThisWorkbook.CustomDocumentProperties.Add _
      Name:="App_ReleaseDate" _
      , LinkToContent:=False _
      , Type:=msoPropertyTypeDate _
      , Value:="31-Jul-2017 1:05pm"
    • To update a setting
      ThisWorkbook.CustomDocumentProperties.Item("App_ReleaseDate").Value = "31-Jul-2017 1:05pm"
    • To delete a setting
      ThisWorkbook.CustomDocumentProperties.Item("App_ReleaseDate").Delete

About (Group)

Add-in Name (Label)

  • The application name with the version

Release Date (Label)

  • The release date of the application

Copyright (Label)

  • The author’s name