ShopToolsUtil Class

Utility features and functionality for the ShopTools application.

Definition

Namespace: ShopTools
Assembly: ShopTools (in ShopTools.exe) Version: 25.2429.4649
C#
public class ShopToolsUtil
Inheritance
Object    ShopToolsUtil

Constructors

ShopToolsUtil 
ShopToolsUtilInitializes a new instance of the ShopToolsUtil class

Properties

ConfigProfile Get/Set a reference to the loaded configuration for this session.
ConfigurationFilename Get/Set the path and filename of the configuration file that was loaded for this session.
SessionConverter Get a reference to the singleton converter for this session.
SessionWorkpieceInfo Get/Set a reference to the session workpiece information.
UserDataPath Get/Set the user's configuration data path.

Methods

BaseUnit Return the base unit of measure for the specified display unit.
CalculateLayout Calculate the start and end locations of the tool and display for each of the operations in the caller's operations collection, returning the final location of the toolpath.
CalculateLayout(CutProfileItem, WorkpieceInfoItem, FPoint) Calculate the start and end locations of the tool and display for each of the operations in the caller's operations collection, returning a collection of locations, each referenced to its associated operation.
CenteredLeft Return the left coordinate of an object centered within an area.
CenteredTop Return the top coordinate of an object centered within an area.
Clamp(Int32, Int32, Int32) Clamp the supplied value within the allowed minimum and maximum values.
Clamp(Single, Single, Single) Clamp the supplied value within the allowed minimum and maximum values.
Clear Clear the contents of the specified string builder.
ConvertRange Convert from one numeric range to another.
DeepCloneT Create a complete, recursive deep clone of the provided object.
DeepTransferT Conduct a deep transfer of all of the lowest level values from the source object to the target.
DrawEllipseCenterDiameter Draw an ellipse using a center coordinate with X and Y diameters.
DrawEllipseCenterRadius Draw an ellipse using a center coordinate with X and Y diameters.
DrawEllipseDiameter Draw an ellipse using the upper left coordinate with X and Y diameters.
DrawEllipseRadius Draw an ellipse using the upper left coordinate with X and Y radii.
DrawHole Draw the drill hole symbol.
DrawLine Draw a line using floating point coordinates, scaling, and translation.
DrawOperation Draw the specified operation to the provided graphics context.
DrawRectangle(FPoint, FPoint, Graphics, Pen, Rectangle, Single) Draw a rectangle using the upper left coordinate with length and width.
DrawRectangle(FPoint, Single, Single, Graphics, Pen, Rectangle, Single) Draw a rectangle using the upper left coordinate with length and width.
DrawRouter Draw the starting or ending router symbol.
DrawTable Draw the work table and the workpiece.
Equals
(Inherited from Object)
ExpandCamelCase Expand a camel-case value to alphanumeric with spaces.
FillEllipseCenterDiameter Draw a filled ellipse using a center coordinate with X and Y diameters.
FillEllipseCenterRadius Draw a filled ellipse using a center coordinate with X and Y diameters.
FillEllipseDiameter Draw a filled ellipse using the upper left coordinate with X and Y diameters.
FillEllipseRadius Draw a filledellipse using the upper left coordinate with X and Y radii.
FillRectangle(FPoint, FPoint, Graphics, Rectangle, Single, Boolean) Fill a rectangle using the upper left coordinate with length and width.
FillRectangle(FPoint, Single, Single, Graphics, Rectangle, Single, Boolean) Fill a rectangle using the upper left coordinate with length and width.
Finalize
(Inherited from Object)
FromMultiLineString Convert a multiline string to a series of limited length lines.
FromTitleCase Convert a string from its title case representation to one with string separators.
GetAltValue Return the formatted alternate measurement value from the caller's value.
GetAngle Return the binary representation of the caller's angle, in degrees, after solving for variables and expressions.
GetBitmapFromDataUri Return a bitmap image from the specified Data URI.
GetDataUri(FileInfo) Return a reference to a Data URI created from the specified binary file.
GetDataUri(String, Byte) Return a reference to a Data URI created from the provided binary data loaded in association with a named file.
GetDisplayCoordinate Return the scaled representation of the caller's drawing space coordinate for use on the current display canvas.
GetFileExtension Return the file extension of the provided filename.
GetFilenameFriendly Return a filename friendly version of the caller's freeform text.
GetFillBrush Return a solid brush used to fill the active area.
GetFloatString Return the formally formatted version of the caller's floating point number.
GetHashCode
(Inherited from Object)
GetIntegerString Return the formally formatted version of the caller's integer number.
GetMeasurementString Return the full measurement string corresponding to the caller's value and default unit.
GetMillimeters Return the caller's value, represented in system millimeters.
GetNonNumeric Return the first non-numeric portion of the caller's string, not including spaces.
GetNumeric Return the first numeric portion of the string.
GetPens Return the pen set for the operation paint appropriate for the specified selection state.
GetPositionZAbs Return the absolute position of Z at the specified position type.
GetRawEndOffset Return the calculated end offset from the caller's starting location.
GetSystemSize Return the system size of the workspace.
GetToolNames Return an array of tool names defined for this session.
GetType
(Inherited from Object)
GetUniqueUserDataImageName Return the first unique variation of the suggested image name within the user data folder.
GetValue(Match, String) Return the value of the specified group member in the provided match.
GetValue(String, String, String) Return the value of the specified group member in a match found with the provided source and pattern.
GetValue(Type, Object, String) Return the value associated with the specified property name of the provided pattern operation.
GetWorkspaceArea Return a reference to the currently configured workspace area for this configuration.
GetWorkspaceRatio Return the ratio of the current workspace's width to its height.
HasFraction Return a value indicating whether the caller's specified value contains a fraction.
HasProperty Return a value indicating whether the provided type has a public property with the specified name.
InitializeApplication Initialize all of the session-level functionality for the application.
IsDataUri Return a value indicating whether the caller's string is a DataURI.
IsXFeed Return a value indicating whether the workspace is primarily viewed as X-feed, rather than Y-feed.
LengthIsX Return a value indicating whether the Length variable runs on the X axis.
MemberwiseClone
(Inherited from Object)
MimeType Return the MIME-type associated with the specified extension.
OffsetArea Return a rectangle whose area has been offset by the specified amount from the source.
ReadConfiguration Read the configuration file.
ResizeArea Return a rectangle of the specified size ratio that perfectly fits into the caller's space.
ResizeImage Resize the image to the specified width and height.
ResolveDepth Return the desired depth for the specified action.
SelectItem The select the first specified item in the provided list by item text.
ToBool(Object) Provide fail-safe conversion of string to boolean value.
ToBool(String, Boolean) Provide fail-safe conversion of string to boolean value.
ToFloat(Object) Provide fail-safe conversion of string to numeric value.
ToFloat(String) Provide fail-safe conversion of string to numeric value.
ToInt(Object) Provide fail-safe conversion of string to numeric value.
ToInt(String) Provide fail-safe conversion of string to numeric value.
ToMultiLineString Return the multi-line single string representation of the items found in the caller's list, where lines that end with a space are continued without a line-break and all other lines are ended with a line break.
ToPoint Convert a single precision floating point point to a System.Drawing.Point.
ToString
(Inherited from Object)
TransformFromAbsolute Return a point on the top, left working space that corresponds to an absolute coordinate on the defined physical table.
TransformToAbsolute Return a point on the physical working space that corresponds to a display-based coordinate.
TranslateDirection(Single, DirectionLeftRightEnum) Translate the relative directional offset from the visual perspective to the defined direction on the table.
TranslateDirection(Single, DirectionUpDownEnum) Translate the relative directional offset from the visual perspective to the defined direction on the table.
TranslateOffset(FArea, Single, OffsetLeftRightEnum, Single) Translate the relative positional offset from the visual perspective to absolute positions based upon the physical anchors on the table or material.
TranslateOffset(FArea, Single, OffsetTopBottomEnum, Single) Translate the relative positional offset from the visual perspective to absolute positions based upon the physical anchors on the table or material.
TranslateOffset(FArea, Single, Single, OffsetLeftRightEnum, Single) Translate the relative positional offset from the visual perspective to absolute positions based upon the physical anchors on the table or material.
TranslateOffset(FArea, Single, Single, OffsetTopBottomEnum, Single) Translate the relative positional offset from the visual perspective to absolute positions based upon the physical anchors on the table or material.
UserDataInitialize Initialize data in the user data folder.
WriteConfiguration Write the contents of the configuration file.

Fields

mColorDrawPen Color used for the non-selected draw pen.
mColorDrawPenSelected Color used for the selected draw pen.
mColorFill Color used for the non-selected area fill.
mColorFillSelected Color used for the selected area fill.
mColorMovePen Color used for the non-selected move pen.
mColorMovePenSelected Color used for the selected move pen.
mColorRouterBackgroundBrush Color used for router background brush.
mColorRouterEndPen Color used for router end position pen.
mColorRouterEndPenSelected Color used for selected router end position pen.
mColorRouterStartPen Color used for router start position pen.
mColorRouterStartPenSelected Color used for selected router start position pen.
mColorScreenBackground Color used for the working screen background.
mColorTargetBackgroundBrush Color used for the drill target area fill.
mColorTargetPen Color used for the non-selected drill target pen.
mColorTargetPenSelected Color used for the selected drill target pen.
mColorWorkpieceBorderPen Color used for workpiece border pen.
mColorWorkpieceBrush Color used for workpiece brush.
mColorWorkspaceBackground Color used for workspace background.
mColorWorkspaceBorderPen Color used for workspace border pen.
mConfigProfile Private member for ConfigProfile.
mConfigurationFilename Private member for ConfigurationFilename.
mSessionConverter Private member for SessionConverter.
mSessionWorkpieceInfo Private member for SessionWorkpieceInfo.
mUserDataPath Private member for UserDataPath.

See Also