Add VI doc

Benji667 · Nov 6, 2021 · fcc1a89 · fcc1a89
1 parent c7bd857
commit fcc1a89
Show file tree

Hide file tree

Showing 15 changed files with 148 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,4 +15,8 @@ Set of LabVIEW custom controls using filled and Windows 11 icons.
 	<HR SIZE="1" WIDTH=" 100.000000%">
 	<H3>Decorations</H3>
 		<IMG SRC="./images/Control Collection/Decorations/Horizontal_Containerp.png"  ALT="Horizontal_Containerp.png">	<IMG SRC="./images/Control Collection/Decorations/Vertical_Containerp.png"  ALT="Vertical_Containerp.png">
+	<A NAME="Decorations _ Change Color.vi"></A><H2>Decorations - Change Color.vi</H2>
+	<P>Dynamically changes the foreground and background colors of all Decorations, droppped from the Custom Controls palette, on the specified <B>VI Refunum</B> Front Panel to the <B>Decoration Color</B>. This VI handles the Label text color to make sure the text stands out from the <B>Decoration Color</B>.</P>
+	<P><IMG SRC="./docs/CustomControls_Help/Decorations_-_Change_Colorc.png" ALT="Decorations - Change Color.vi"></P>
 </DIV>
+
diff --git a/docs/CustomControls_Help/CustomControls_Help.html b/docs/CustomControls_Help/CustomControls_Help.html
@@ -0,0 +1,144 @@
+<HTML>
+<HEAD>
+<TITLE>Decorations - Change Color.vi</TITLE>
+<META NAME="Author" CONTENT="">
+<META NAME="GENERATOR" CONTENT="G Development Environment">
+</HEAD>
+<BODY BGCOLOR="#FFFFFF">
+<A NAME="Decorations _ Change Color.vi"></A><H2>Decorations - Change Color.vi</H2>
+<P>Dynamically changes the foreground and background colors of all Decorations, droppped from the Custom Controls palette, on the specified <B>VI Refunum</B> Front Panel to the <B>Decoration Color</B>. This VI handles the Label text color to make sure the text stands out from the <B>Decoration Color</B>.</P>
+<P><IMG SRC="Decorations_-_Change_Colorc.png" ALT="Decorations - Change Color.vi"></P>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="cvirn.png" ALT="cvirn"></P>
+</TD>
+<TD>
+<B>VI Refnum</B> <P><B>VI Refnum</B> is the reference to the VI you want to change the color of its Custom Controls&gt;&gt;Decorations droppped on its Front-Panel. </P>
+</TD>
+</TR>
+</Table>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="cu32.png" ALT="cu32"></P>
+</TD>
+<TD>
+<B>Decoration Color</B> <P><B>Decoration Color</B> is the color you want to set to the Custom Controls&gt;&gt;Decorations.</P>
+</TD>
+</TR>
+</Table>
+<Table>
+</UL>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="cerrcodeclst.png" ALT="cerrcodeclst"></P>
+</TD>
+<TD>
+<B>error in (no error)</B> <P><B>error in</B> can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+<UL>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="cbool.png" ALT="cbool"></P>
+</TD>
+<TD>
+<B>status</B> <P><B>status</B> is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="ci32.png" ALT="ci32"></P>
+</TD>
+<TD>
+<B>code</B> <P><B>code</B> is the error or warning code.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="cstr.png" ALT="cstr"></P>
+</TD>
+<TD>
+<B>source</B> <P><B>source</B> describes the origin of the error or warning.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+</UL>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="ivirn.png" ALT="ivirn"></P>
+</TD>
+<TD>
+<B>dup VI Refnum</B> <P><B>dup VI Refnum</B> returns <B>VI Refnum</B> unchanged.</P>
+</TD>
+</TR>
+</Table>
+</UL>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="ierrcodeclst.png" ALT="ierrcodeclst"></P>
+</TD>
+<TD>
+<B>error out</B> <P><B>error in</B> can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+<UL>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="ibool.png" ALT="ibool"></P>
+</TD>
+<TD>
+<B>status</B> <P><B>status</B> is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="ii32.png" ALT="ii32"></P>
+</TD>
+<TD>
+<B>code</B> <P><B>code</B> is the error or warning code.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+<Table>
+<TR valign=TOP>
+<TD>
+<P><IMG SRC="istr.png" ALT="istr"></P>
+</TD>
+<TD>
+<B>source</B> <P><B>source</B> describes the origin of the error or warning.</P>
+<P></P>
+<P>Right-click the <B>error in</B> control on the front panel and select <B>Explain Error</B> or <B>Explain Warning</B> from the shortcut menu for more information about the error.</P>
+</TD>
+</TR>
+</Table>
+</UL>
+</BODY>
+</HTML>
diff --git a/docs/CustomControls_Help/Decorations_-_Change_Colorc.png b/docs/CustomControls_Help/Decorations_-_Change_Colorc.png
diff --git a/docs/CustomControls_Help/cbool.png b/docs/CustomControls_Help/cbool.png
diff --git a/docs/CustomControls_Help/cerrcodeclst.png b/docs/CustomControls_Help/cerrcodeclst.png
diff --git a/docs/CustomControls_Help/ci32.png b/docs/CustomControls_Help/ci32.png
diff --git a/docs/CustomControls_Help/cstr.png b/docs/CustomControls_Help/cstr.png
diff --git a/docs/CustomControls_Help/cu32.png b/docs/CustomControls_Help/cu32.png
diff --git a/docs/CustomControls_Help/cvirn.png b/docs/CustomControls_Help/cvirn.png
diff --git a/docs/CustomControls_Help/ibool.png b/docs/CustomControls_Help/ibool.png
diff --git a/docs/CustomControls_Help/ierrcodeclst.png b/docs/CustomControls_Help/ierrcodeclst.png
diff --git a/docs/CustomControls_Help/ii32.png b/docs/CustomControls_Help/ii32.png
diff --git a/docs/CustomControls_Help/istr.png b/docs/CustomControls_Help/istr.png
diff --git a/docs/CustomControls_Help/ivirn.png b/docs/CustomControls_Help/ivirn.png
diff --git a/src/Utilities/Decorations - Change Color.vi b/src/Utilities/Decorations - Change Color.vi