wagesj45/butterflow-ui
1
0
Fork 0
mirror of https://github.com/wagesj45/butterflow-ui.git synced 2024-12-22 09:12:42 -06:00
Code Issues Releases Wiki Activity
butterflow-ui/docs/html/98c35fae-9e4e-225a-03af-5da2f15cccc7.htm
Jordan Wages 43c3db77d8 Documentation Update 
Updated documentation.
2018-09-12 22:56:20 -05:00

8 lines
No EOL
12 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ButterflowWrapper Methods</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="ButterflowWrapper class, methods" /><meta name="Microsoft.Help.Id" content="Methods.T:butterflow_ui.ButterflowWrapper" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="butterflow_ui" /><meta name="file" content="98c35fae-9e4e-225a-03af-5da2f15cccc7" /><meta name="guid" content="98c35fae-9e4e-225a-03af-5da2f15cccc7" /><link type="text/css" rel="stylesheet" href="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"> </script><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">A Sandcastle Documented Class Library<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html\e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm" title="A Sandcastle Documented Class Library" tocid="roottoc">A Sandcastle Documented Class Library</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm" title="butterflow_ui" tocid="e151fc72-f3cc-1740-7ea1-73c21ce1fa93">butterflow_ui</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/fbe7965e-3c27-b071-c7cb-326cec0f4597.htm" title="ButterflowWrapper Class" tocid="fbe7965e-3c27-b071-c7cb-326cec0f4597">ButterflowWrapper Class</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/98c35fae-9e4e-225a-03af-5da2f15cccc7.htm" title="ButterflowWrapper Methods" tocid="98c35fae-9e4e-225a-03af-5da2f15cccc7">ButterflowWrapper Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/4ae309d0-c1b6-0cf8-5c03-ff0ca2ba871c.htm" title="Cancel Method " tocid="4ae309d0-c1b6-0cf8-5c03-ff0ca2ba871c">Cancel Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/0f122b25-75d9-5e1d-4ad9-9e6f94f7a15e.htm" title="GetDevices Method " tocid="0f122b25-75d9-5e1d-4ad9-9e6f94f7a15e">GetDevices Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/ca122bba-d422-fdb9-8331-909a7897edb9.htm" title="OnButterflowExited Method " tocid="ca122bba-d422-fdb9-8331-909a7897edb9">OnButterflowExited Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/c16980db-32b2-dc80-d568-ef30ce3ea3bf.htm" title="OnParsedConsoleOutputRecieved Method " tocid="c16980db-32b2-dc80-d568-ef30ce3ea3bf">OnParsedConsoleOutputRecieved Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/a40dbce6-a556-a0b5-a504-e0e6b5f9b2b2.htm" title="ParseConsoleOutput Method " tocid="a40dbce6-a556-a0b5-a504-e0e6b5f9b2b2">ParseConsoleOutput Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/5f2749a7-c303-eaab-d82d-6b5a5d5957af.htm" title="Probe Method " tocid="5f2749a7-c303-eaab-d82d-6b5a5d5957af">Probe Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/ecdfd054-a9b2-3571-09c4-a006bae59ed2.htm" title="Process_Exited Method " tocid="ecdfd054-a9b2-3571-09c4-a006bae59ed2">Process_Exited Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/ade5760c-a582-25e6-1253-15bbccd18447.htm" title="Process_OutputDataReceived Method " tocid="ade5760c-a582-25e6-1253-15bbccd18447">Process_OutputDataReceived Method </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/8a2f8de4-a4d7-02a5-2edf-5d86511ecf0c.htm" title="ProcessQueue Method " tocid="8a2f8de4-a4d7-02a5-2edf-5d86511ecf0c">ProcessQueue Method </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/1282edb3-a085-8b0a-9eed-131760d451b5.htm" title="Run Method " tocid="1282edb3-a085-8b0a-9eed-131760d451b5">Run Method </a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>ButterflowWrapper Methods</h1></td></tr></table><span class="introStyle"></span> <p>The <a href="fbe7965e-3c27-b071-c7cb-326cec0f4597.htm">ButterflowWrapper</a> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID0RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="94283020-fd41-a0ab-0e86-5d285dc72cff.htm">AddConstantCallProperty</a></td><td><div class="summary"> Adds a property that will always be called when any property is updated.. </div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="4ae309d0-c1b6-0cf8-5c03-ff0ca2ba871c.htm">Cancel</a></td><td><div class="summary"> Kills the running instance of butterflow, cancelling its current operation. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="0f122b25-75d9-5e1d-4ad9-9e6f94f7a15e.htm">GetDevices</a></td><td><div class="summary"> Gets the devices available for butterflow processing. </div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="f4ce3949-e7fd-ce94-51cc-3c3698c097b5.htm">OnAllPropertiesChanged</a></td><td><div class="summary"> Executes when all properties are changed and should be updated. </div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="ca122bba-d422-fdb9-8331-909a7897edb9.htm">OnButterflowExited</a></td><td><div class="summary"> Executes the butterflow exited action. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="c16980db-32b2-dc80-d568-ef30ce3ea3bf.htm">OnParsedConsoleOutputRecieved</a></td><td><div class="summary"> Executes the parsed console output recieved action. </div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /><img src="../icons/CodeExample.png" alt="Code example" title="Code example" /></td><td><a href="eedea241-4ddb-bac9-5717-c691ef57e6ea.htm">OnPropertyChanged</a></td><td><div class="summary">
Executes the property changed action. This alerts subscribers to its change in value.
</div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="a40dbce6-a556-a0b5-a504-e0e6b5f9b2b2.htm">ParseConsoleOutput</a></td><td><div class="summary">
Parses console output and attempts to find known values. If a known value is found, the
event is triggered.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="5f2749a7-c303-eaab-d82d-6b5a5d5957af.htm">Probe</a></td><td><div class="summary"> Probes a video file. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="ecdfd054-a9b2-3571-09c4-a006bae59ed2.htm">Process_Exited</a></td><td><div class="summary"> Event handler. Called by Process for exited events. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="ade5760c-a582-25e6-1253-15bbccd18447.htm">Process_OutputDataReceived</a></td><td><div class="summary"> Event handler. Called by Process for output data received events. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="8a2f8de4-a4d7-02a5-2edf-5d86511ecf0c.htm">ProcessQueue</a></td><td><div class="summary"> Process the queue of butterflow arguments. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="e76fa5c5-defd-752c-1b7d-1a6e0e849e94.htm">Run(String)</a></td><td><div class="summary"> Runs butterflow with the given <span class="parameter">arguments</span> by adding it to the queue. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="1970f320-0445-a329-d826-7eb6c236d533.htm">Run(OptionsConfiguration)</a></td><td><div class="summary"> Runs butterflow with the given <span class="parameter">optionsConfiguration</span> by adding it to the queue. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="fbe7965e-3c27-b071-c7cb-326cec0f4597.htm">ButterflowWrapper Class</a></div><div class="seeAlsoStyle"><a href="e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm">butterflow_ui Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
Reference in a new issue View git blame Copy permalink