4010 lines
188 KiB
XML
4010 lines
188 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Xarial.XCad</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Xarial.XCad.Annotations.IXDimension">
|
|
<summary>
|
|
Annotation which drives the dimension parameter
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Annotations.IXDimension.ValueChanged">
|
|
<summary>
|
|
Fired when the value of this dimension is changed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Annotations.IXDimension.Name">
|
|
<summary>
|
|
Name of the dimension
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Annotations.IXDimension.GetValue(System.String)">
|
|
<summary>
|
|
Gets the value of the dimension in the system units in the specified configuration or default
|
|
</summary>
|
|
<param name="confName">Name of the configuration</param>
|
|
<returns>Dimension value</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Annotations.IXDimension.SetValue(System.Double,System.String)">
|
|
<summary>
|
|
Sets the value of the dimension in the specified configuration
|
|
</summary>
|
|
<param name="val">Value to set in the system units</param>
|
|
<param name="confName">Name of the configuration or default</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Annotations.IXDimensionRepositoryExtension.TryGetDimensionValue(Xarial.XCad.Annotations.IXDimensionRepository,System.String,System.String)">
|
|
<summary>
|
|
Tries to get the value of the dimension
|
|
</summary>
|
|
<param name="repo">Repository</param>
|
|
<param name="dimName">Name of the dimension</param>
|
|
<param name="confName">Optional name of the configuration</param>
|
|
<returns>Value of the dimension or NaN if dimension does not exist</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Annotations.IXDimensionRepositoryExtension.TrySetDimensionValue(Xarial.XCad.Annotations.IXDimensionRepository,System.String,System.Double,System.String)">
|
|
<summary>
|
|
Tries to set the value of the dimension
|
|
</summary>
|
|
<param name="repo">Repository</param>
|
|
<param name="dimName">Name of the dimension</param>
|
|
<param name="value">Value to set</param>
|
|
<param name="confName"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Annotations.IXNote">
|
|
<summary>
|
|
Represents the note annotation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Annotations.IXNote.Text">
|
|
<summary>
|
|
Text of the note
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.Attributes.IconAttribute">
|
|
<summary>
|
|
General icon for any controls or objects
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.Attributes.IconAttribute.Icon">
|
|
<summary>
|
|
Image assigned to this icon
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.IconAttribute.#ctor">
|
|
<summary>
|
|
Constructor without icon initialization
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.IconAttribute.#ctor(Xarial.XCad.UI.IXImage)">
|
|
<summary>
|
|
Constructor to be used in dynamic controls
|
|
</summary>
|
|
<param name="icon"></param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.IconAttribute.#ctor(System.Type,System.String)">
|
|
<param name="resType">Type of the static class (usually Resources)</param>
|
|
<param name="masterResName">Resource name of the master icon</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.Attributes.SummaryAttribute">
|
|
<summary>
|
|
Decorates the description for the element (e.g. command, user control, object etc.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.SummaryAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Constructor for element summary
|
|
</summary>
|
|
<param name="description">Description of the element</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.SummaryAttribute.#ctor(System.Type,System.String)">
|
|
<inheritdoc cref="M:Xarial.XCad.Base.Attributes.SummaryAttribute.#ctor(System.String)"/>
|
|
<param name="resType">Type of the static class (usually Resources)</param>
|
|
<param name="descriptionResName">Resource name of the string for display name</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.Attributes.TitleAttribute">
|
|
<summary>
|
|
Decorates the display name for the element (e.g. command, user control, object etc.)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.TitleAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Constructor for element title
|
|
</summary>
|
|
<param name="dispName">Display name of the element</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.Attributes.TitleAttribute.#ctor(System.Type,System.String)">
|
|
<inheritdoc cref="M:Xarial.XCad.Base.Attributes.TitleAttribute.#ctor(System.String)"/>
|
|
<param name="resType">Type of the static class (usually Resources)</param>
|
|
<param name="dispNameResName">Resource name of the string for display name</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.Enums.LoggerMessageSeverity_e">
|
|
<summary>
|
|
Type of the logger message
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Base.Enums.LoggerMessageSeverity_e.Information">
|
|
<summary>
|
|
Information message
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Base.Enums.LoggerMessageSeverity_e.Warning">
|
|
<summary>
|
|
Warning message
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Base.Enums.LoggerMessageSeverity_e.Error">
|
|
<summary>
|
|
Error message
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Base.Enums.LoggerMessageSeverity_e.Fatal">
|
|
<summary>
|
|
Represents the fatal error
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Base.Enums.LoggerMessageSeverity_e.Debug">
|
|
<summary>
|
|
Represents debug information
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IEvaluation">
|
|
<summary>
|
|
This interfaces represents the geometrical evaluation features
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IEvaluation.RelativeTo">
|
|
<summary>
|
|
Evaluates geometry relative to the specified transformation matrix
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IEvaluation.UserUnits">
|
|
<summary>
|
|
True to use user specific units, false to use system units
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IEvaluation.VisibleOnly">
|
|
<summary>
|
|
True to only use visible bodies or components
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IEvaluation.Scope">
|
|
<summary>
|
|
Bodies to include into the evaluation
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IAssemblyEvaluation">
|
|
<summary>
|
|
Assembly specific geometrical evaluation feature
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IAssemblyEvaluation.Scope">
|
|
<summary>
|
|
Components to include into the evaluation
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.ITooltipSpec">
|
|
<summary>
|
|
Defines the specification of the tooltip used in the <see cref="M:Xarial.XCad.IXApplication.ShowTooltip(Xarial.XCad.Base.ITooltipSpec)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.ITooltipSpec.Title">
|
|
<summary>
|
|
Title of tooltip
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.ITooltipSpec.Message">
|
|
<summary>
|
|
Message to show in tooltip
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.ITooltipSpec.Position">
|
|
<summary>
|
|
Position of the tooltip
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.ITooltipSpec.ArrowPosition">
|
|
<summary>
|
|
Position of tooltip arrow
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IXLogger">
|
|
<summary>
|
|
Logs the trace messages
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXLogger.Log(System.String,Xarial.XCad.Base.Enums.LoggerMessageSeverity_e)">
|
|
<summary>
|
|
Logs message
|
|
</summary>
|
|
<param name="msg">Message</param>
|
|
<param name="severity">Type of the message</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.ILoggerExtension">
|
|
<summary>
|
|
Additional extension methods for the logger
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.ILoggerExtension.Log(Xarial.XCad.Base.IXLogger,System.Exception,System.Boolean,Xarial.XCad.Base.Enums.LoggerMessageSeverity_e)">
|
|
<summary>
|
|
Logs error
|
|
</summary>
|
|
<param name="logger">Logger</param>
|
|
<param name="ex">Exception</param>
|
|
<param name="stackTrace">True to log stack trace</param>
|
|
<param name="severity">Severity of the message</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IXRepository`1">
|
|
<summary>
|
|
Represents the collection of elements
|
|
</summary>
|
|
<typeparam name="TEnt"></typeparam>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IXRepository`1.Count">
|
|
<summary>
|
|
Number of elements in the collection
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IXRepository`1.Item(System.String)">
|
|
<summary>
|
|
Retrieves the element by name
|
|
</summary>
|
|
<param name="name">Name of the element</param>
|
|
<returns>Pointer to element</returns>
|
|
<remarks>This method should through an exception for missing element. Use <see cref="M:Xarial.XCad.Base.IXRepository`1.TryGet(System.String,`0@)"/>for a safe way getting the element</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXRepository`1.TryGet(System.String,`0@)">
|
|
<summary>
|
|
Attempts to get element by name
|
|
</summary>
|
|
<param name="name">Name of the element</param>
|
|
<param name="ent">Resulting element if exists or null otherwise</param>
|
|
<returns>True if element exists</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXRepository`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>
|
|
Commits entities
|
|
</summary>
|
|
<param name="ents"></param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXRepository`1.RemoveRange(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>
|
|
Removes specified enitites
|
|
</summary>
|
|
<param name="ents">Entities to remove</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IXRepositoryExtension">
|
|
<summary>
|
|
Provides additional methods for <see cref="T:Xarial.XCad.Base.IXRepository`1"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXRepositoryExtension.Add``1(Xarial.XCad.Base.IXRepository{``0},``0[])">
|
|
<summary>
|
|
Adds object one-by-one or as an array
|
|
</summary>
|
|
<typeparam name="TEnt">Type of entity</typeparam>
|
|
<param name="repo">Target repository</param>
|
|
<param name="ents">Entities to add</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXRepositoryExtension.Get``1(Xarial.XCad.Base.IXRepository{``0},System.String)">
|
|
<summary>
|
|
Gets the entity by name
|
|
</summary>
|
|
<typeparam name="TEnt">Type of entity</typeparam>
|
|
<param name="repo">Target repository</param>
|
|
<param name="name">Name of the entity</param>
|
|
<returns>Pointer to named entity</returns>
|
|
<exception cref="T:Xarial.XCad.Exceptions.EntityNotFoundException"/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IXTransaction">
|
|
<summary>
|
|
Represents the element which can be precreated
|
|
</summary>
|
|
<Remarks>Those elements usually got created within the <see cref="!:IXRepository.AddRange(IEnumerable<TEnt>)"/></Remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Base.IXTransaction.IsCommitted">
|
|
<summary>
|
|
Identifies if this element is created or a template
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXTransaction.Commit(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Commits this transaction
|
|
</summary>
|
|
<param name="cancellationToken">Cancellation token</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Base.IXTransactionExtension">
|
|
<summary>
|
|
Additional methods for <see cref="T:Xarial.XCad.Base.IXTransaction"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Base.IXTransactionExtension.Commit(Xarial.XCad.Base.IXTransaction)">
|
|
<summary>
|
|
Commits the transaction with default cancellation token
|
|
</summary>
|
|
<param name="transaction">Transaction to commit</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.Delegates.PropertyValueChangedDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.Data.IXProperty.ValueChanged"/> event
|
|
</summary>
|
|
<param name="prp">Event sender</param>
|
|
<param name="newValue">New value assigned to the property</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.IPropertiesOwner">
|
|
<summary>
|
|
Specifies that this entity has properties
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Data.IPropertiesOwner.Properties">
|
|
<summary>
|
|
Collection of properties
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.ITagsManager">
|
|
<summary>
|
|
Manages custom user metadata within this <see cref="P:Xarial.XCad.IXObject.Tags"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.ITagsManager.Contains(System.String)">
|
|
<summary>
|
|
Checks if the tags contains named metadata
|
|
</summary>
|
|
<param name="name">Name of the metadata</param>
|
|
<returns>True if metadata exists</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.ITagsManager.Put``1(System.String,``0)">
|
|
<summary>
|
|
Adds the specified metadata to the tags
|
|
</summary>
|
|
<typeparam name="T">Type of metadata</typeparam>
|
|
<param name="name">Name of metadata</param>
|
|
<param name="value">Metadata</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.ITagsManager.Get``1(System.String)">
|
|
<summary>
|
|
Returns the specified metadata by name
|
|
</summary>
|
|
<typeparam name="T">Type of the metadata</typeparam>
|
|
<param name="name">Name of the metadata</param>
|
|
<returns>Instance of the metadata</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.ITagsManager.Pop``1(System.String)">
|
|
<summary>
|
|
Pops the specified metadata from the tags (instance is removed from the tags)
|
|
</summary>
|
|
<typeparam name="T">Type of the metadata</typeparam>
|
|
<param name="name">Name of the metadata</param>
|
|
<returns>Instance of the metadata</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.IXProperty">
|
|
<summary>
|
|
Represents the custom property
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Data.IXProperty.ValueChanged">
|
|
<summary>
|
|
Raised when the value of this property is changed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Data.IXProperty.Name">
|
|
<summary>
|
|
Name of the property
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Data.IXProperty.Value">
|
|
<summary>
|
|
Property value
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Data.IXProperty.Expression">
|
|
<summary>
|
|
Property equation
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.IXPropertyExtension">
|
|
<summary>
|
|
Additional methods for property
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.IXPropertyExtension.Exists(Xarial.XCad.Data.IXProperty)">
|
|
<summary>
|
|
True if this property exists
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.IXPropertyRepository">
|
|
<summary>
|
|
Represents the collection of properties
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.IXPropertyRepository.PreCreate">
|
|
<summary>
|
|
Pre-creates new property
|
|
</summary>
|
|
<returns>Property template</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Data.IXPropertyRepositoryExtension">
|
|
<summary>
|
|
Additional methods for <see cref="T:Xarial.XCad.Data.IXPropertyRepository"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.IXPropertyRepositoryExtension.Set(Xarial.XCad.Data.IXPropertyRepository,System.String,System.Object)">
|
|
<summary>
|
|
Sets the value for this poperty
|
|
</summary>
|
|
<param name="prps">Repository</param>
|
|
<param name="prpName">Name of the property</param>
|
|
<param name="prpVal">Proeprty value</param>
|
|
<remarks>This method will change the value of existing property or create new one if not exist</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Data.IXPropertyRepositoryExtension.GetOrPreCreate(Xarial.XCad.Data.IXPropertyRepository,System.String)">
|
|
<summary>
|
|
Gets or pre creates property
|
|
</summary>
|
|
<param name="prps">Repository</param>
|
|
<param name="name">Name of the property</param>
|
|
<returns>Existing proeprty or non-commited property</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Defaults">
|
|
<summary>
|
|
Collection of default objects
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Defaults.Icon">
|
|
<summary>
|
|
Default icon
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Delegates.ApplicationStartingDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.IXApplication.Starting"/> event
|
|
</summary>
|
|
<param name="sender">Application which is starting</param>
|
|
<param name="process">Application process</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Delegates.ConfigureServicesDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.IXServiceConsumer.ConfigureServices"/> event
|
|
</summary>
|
|
<param name="sender">Sender of this event</param>
|
|
<param name="collection">Collection of services to configure</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Delegates.ConfigurationActivatedDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.Documents.IXConfigurationRepository.ConfigurationActivated"/> event
|
|
</summary>
|
|
<param name="doc">Document owner of this configuration</param>
|
|
<param name="newConf">Configuration which is activated</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Enums.BomChildrenSolving_e">
|
|
<summary>
|
|
Enumeration used in <see cref="P:Xarial.XCad.Documents.IXConfiguration.BomChildrenSolving"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.BomChildrenSolving_e.Show">
|
|
<summary>
|
|
Show children of this configuration
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.BomChildrenSolving_e.Hide">
|
|
<summary>
|
|
Hide children of this configuration in the BOM
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.BomChildrenSolving_e.Promote">
|
|
<summary>
|
|
Promote children of this configuration (dissolve the assembly)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Enums.ComponentState_e">
|
|
<summary>
|
|
States of the component <see cref="P:Xarial.XCad.Documents.IXComponent.State"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.Default">
|
|
<summary>
|
|
Default state of the component
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.Suppressed">
|
|
<summary>
|
|
Component is suppressed
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.Lightweight">
|
|
<summary>
|
|
Component is loaded in the lightweight mode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.ViewOnly">
|
|
<summary>
|
|
Component is loaded in view-only mode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.Hidden">
|
|
<summary>
|
|
Component is hidden
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.ExcludedFromBom">
|
|
<summary>
|
|
Component is excluded from Bill Of Materials
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.Envelope">
|
|
<summary>
|
|
Components is created as envelope
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.ComponentState_e.Embedded">
|
|
<summary>
|
|
Component is embedded (virtual) into the assembly
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Enums.DocumentState_e">
|
|
<summary>
|
|
Represents the state of the document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.DocumentState_e.Default">
|
|
<summary>
|
|
Default state of the document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.DocumentState_e.Hidden">
|
|
<summary>
|
|
Checks if document is hidden
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.DocumentState_e.ReadOnly">
|
|
<summary>
|
|
Opens document in read-only mode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.DocumentState_e.ViewOnly">
|
|
<summary>
|
|
Opens document in view only mode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.DocumentState_e.Silent">
|
|
<summary>
|
|
Opens document without displaying any popup messages
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.Enums.DocumentState_e.Rapid">
|
|
<summary>
|
|
Opens document in the rapid mode
|
|
</summary>
|
|
<remarks>This mode significantly improves the performance of opening but certain functionality and API migth not be available</remarks>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Exceptions.DocumentWriteAccessDeniedException">
|
|
<summary>
|
|
Exception indicates that document cannot be opened for write access
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.Exceptions.DocumentWriteAccessDeniedException.#ctor(System.String,System.Int32)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Exceptions.FilePathResolveFailedException">
|
|
<summary>
|
|
Exception indicates that path of the unloaded document canot be resolved
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.Exceptions.FilePathResolveFailedException.#ctor(System.String)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
<param name="inputPath">Document path</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Exceptions.OpenDocumentFailedException">
|
|
<summary>
|
|
Exception thrown when file cannot be opened
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.Exceptions.OpenDocumentFailedException.Path">
|
|
<summary>
|
|
Path to the file
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.Exceptions.OpenDocumentFailedException.ErrorCode">
|
|
<summary>
|
|
Application specific error code
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.Exceptions.OpenDocumentFailedException.#ctor(System.String,System.Int32,System.String)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Exceptions.SaveDocumentFailedException">
|
|
<summary>
|
|
Exception indicates that document failed to save
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.Exceptions.SaveDocumentFailedException.ErrorCode">
|
|
<summary>
|
|
CAD specific error code
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.Exceptions.SaveDocumentFailedException.#ctor(System.Int32,System.String)">
|
|
<summary>
|
|
Exception constructor
|
|
</summary>
|
|
<param name="errCode">Error code</param>
|
|
<param name="errorDesc">Description</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.Extensions.IXDocumentExtension.GetAllDependencies(Xarial.XCad.Documents.IXDocument)">
|
|
<summary>
|
|
Returns all dependencies including nested dependencies
|
|
</summary>
|
|
<param name="doc">Input document</param>
|
|
<returns>All dependencies</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXAssembly">
|
|
<summary>
|
|
Represents an assembly document (composition of <see cref="T:Xarial.XCad.Documents.IXPart"/> and other <see cref="T:Xarial.XCad.Documents.IXAssembly"/>)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXAssembly.Configurations">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXAssembly.PreCreateBoundingBox">
|
|
<summary>
|
|
Pre creates the 3D bounding box of the assembly
|
|
</summary>
|
|
<returns>Bounding box</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXAssembly.PreCreateMassProperty">
|
|
<summary>
|
|
Pre creates mass properties of the assembly
|
|
</summary>
|
|
<returns>Mass property</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXAssemblyConfiguration">
|
|
<summary>
|
|
Represents the configuration of the assembly
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXAssemblyConfiguration.Components">
|
|
<summary>
|
|
Components in this assembly configuration
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXAssemblyConfigurationRepository">
|
|
<summary>
|
|
Represents the collection of configurations in <see cref="T:Xarial.XCad.Documents.IXAssembly"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXAssemblyConfigurationRepository.Active">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXAssemblyConfigurationRepository.PreCreate">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXComponent">
|
|
<summary>
|
|
Represents components in the <see cref="T:Xarial.XCad.Documents.IXAssembly"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.Name">
|
|
<summary>
|
|
Name of the component
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.Path">
|
|
<summary>
|
|
Gets the path of this component
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.ReferencedConfiguration">
|
|
<summary>
|
|
Returns the referenced configuration of this component
|
|
</summary>
|
|
<remarks>For unloaded or rapid components this configuration may be uncommitted</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.State">
|
|
<summary>
|
|
State of this component
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.Document">
|
|
<summary>
|
|
Document of the component
|
|
</summary>
|
|
<remarks>If component is rapid, view only or suppressed document migth not be loaded into the memory. Use <see cref="P:Xarial.XCad.Base.IXTransaction.IsCommitted"/> to check the state and call <see cref="M:Xarial.XCad.Base.IXTransaction.Commit(System.Threading.CancellationToken)"/> to load document if needed</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.Children">
|
|
<summary>
|
|
Children components
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.Features">
|
|
<summary>
|
|
Features of this components
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponent.Bodies">
|
|
<summary>
|
|
Bodies in this component
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXComponentExtension">
|
|
<summary>
|
|
Additional methods for <see cref="T:Xarial.XCad.Documents.IXComponent"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXComponentExtension.IterateBodies(Xarial.XCad.Documents.IXComponent,System.Boolean)">
|
|
<summary>
|
|
Gets all bodies from the components
|
|
</summary>
|
|
<param name="comp">Component</param>
|
|
<param name="includeHidden">True to include all bodies, false to only include visible</param>
|
|
<returns>Bodies</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXComponentExtension.IterateBodies(Xarial.XCad.Documents.IXComponentRepository,System.Boolean)">
|
|
<inheritdoc cref="M:Xarial.XCad.Documents.IXComponentExtension.IterateBodies(Xarial.XCad.Documents.IXComponent,System.Boolean)"/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXComponentRepository">
|
|
<summary>
|
|
Represents the collection of <see cref="T:Xarial.XCad.Documents.IXComponent"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXComponentRepository.TotalCount">
|
|
<summary>
|
|
Returns the total count of components including all nested components
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXComponentRepositoryExtension">
|
|
<summary>
|
|
Additonal methods of <see cref="T:Xarial.XCad.Documents.IXComponentRepository"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXComponentRepositoryExtension.Flatten(Xarial.XCad.Documents.IXComponentRepository)">
|
|
<summary>
|
|
Returns all components, including children
|
|
</summary>
|
|
<param name="repo">Components repository</param>
|
|
<returns>All components</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXConfiguration">
|
|
<summary>
|
|
Represents the configiration (variant) of the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfiguration.Quantity">
|
|
<summary>
|
|
BOM quantity value
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfiguration.Name">
|
|
<summary>
|
|
Name of the configuration
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfiguration.PartNumber">
|
|
<summary>
|
|
Returns part number of this configuration
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfiguration.BomChildrenSolving">
|
|
<summary>
|
|
Options for displaying this configuration in BOM
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfiguration.CutLists">
|
|
<summary>
|
|
Cut-list items in this configuration (if available)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfiguration.Preview">
|
|
<summary>
|
|
Preview image of this configuration
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXConfigurationRepository">
|
|
<summary>
|
|
Represents the collection of configurations in <see cref="T:Xarial.XCad.Documents.IXDocument3D"/>
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXConfigurationRepository.ConfigurationActivated">
|
|
<summary>
|
|
Fired when configuration is activated
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXConfigurationRepository.Active">
|
|
<summary>
|
|
Returns the currently active configuration or activates the specific configuration
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXConfigurationRepository.PreCreate">
|
|
<summary>
|
|
Creates new template configuration
|
|
</summary>
|
|
<returns>Pre-created configuration</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDocument">
|
|
<summary>
|
|
Represents the base interface of all document types
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Version">
|
|
<summary>
|
|
Current version of the document
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.StreamReadAvailable">
|
|
<summary>
|
|
Fired when user data stream is available for reading
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.StorageReadAvailable">
|
|
<summary>
|
|
Fired when user data storage is available for reading
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.StreamWriteAvailable">
|
|
<summary>
|
|
Fired when user data stream is available for writing
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.StorageWriteAvailable">
|
|
<summary>
|
|
Fired when user data storage is available for writing
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.Rebuild">
|
|
<summary>
|
|
Fired when document is rebuilt
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.Saving">
|
|
<summary>
|
|
Fired when documetn is saving
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocument.Closing">
|
|
<summary>
|
|
Fired when document is closing
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Title">
|
|
<summary>
|
|
Changes the title of this document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Template">
|
|
<summary>
|
|
Document template
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Path">
|
|
<summary>
|
|
Path to the document (if saved)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.IsDirty">
|
|
<summary>
|
|
Checks if document has any unsaved changes
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.State">
|
|
<summary>
|
|
Gets or sets the state of the document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument.Close">
|
|
<summary>
|
|
Closes this document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument.Save">
|
|
<summary>
|
|
Saves this document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument.SaveAs(System.String)">
|
|
<summary>
|
|
Saves this document to a new location
|
|
</summary>
|
|
<param name="filePath"></param>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Features">
|
|
<summary>
|
|
Collection of features of this document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Selections">
|
|
<summary>
|
|
Collection of selections of this document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Dimensions">
|
|
<summary>
|
|
Collection of dimensions of this document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument.OpenStream(System.String,Xarial.XCad.Data.Enums.AccessType_e)">
|
|
<summary>
|
|
Opens the user data stream from this document
|
|
</summary>
|
|
<param name="name">Name of the stream</param>
|
|
<param name="access">Access type</param>
|
|
<returns>Pointer to stream</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument.OpenStorage(System.String,Xarial.XCad.Data.Enums.AccessType_e)">
|
|
<summary>
|
|
Opens the user data storage from this document
|
|
</summary>
|
|
<param name="name">Name of the storage</param>
|
|
<param name="access">Access type</param>
|
|
<returns>Pointer to the storage</returns>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.Dependencies">
|
|
<summary>
|
|
Returns top level dependencies of this document
|
|
</summary>
|
|
<remarks>Dependencies might be uncommited if document is loaded view only or in the rapid mode. Use <see cref="P:Xarial.XCad.Base.IXTransaction.IsCommitted"/> to check the state and call <see cref="M:Xarial.XCad.Base.IXTransaction.Commit(System.Threading.CancellationToken)"/> to load document if needed.
|
|
In most CADs this method wil lwork with uncommitted documents</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument.DeserializeObject``1(System.IO.Stream)">
|
|
<summary>
|
|
Deserializes specific object from stream
|
|
</summary>
|
|
<param name="stream">Input stream with the serialized object</param>
|
|
<returns>Deserialized object</returns>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument.UpdateStamp">
|
|
<summary>
|
|
Returns the time stamp of the change of the current model
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXUnknownDocument">
|
|
<summary>
|
|
Represents the unknown document type
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXUnknownDocument.GetSpecific">
|
|
<summary>
|
|
Retrieves the specific document from the unknown document
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDocument3D">
|
|
<summary>
|
|
Represents 3D document (assembly or part)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument3D.PreCreateBoundingBox">
|
|
<summary>
|
|
Pre creates the 3D bounding box of the document
|
|
</summary>
|
|
<returns>Bounding box</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocument3D.PreCreateMassProperty">
|
|
<summary>
|
|
Pre creates the mass property evaluator for the document
|
|
</summary>
|
|
<returns>Mass property</returns>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument3D.ModelViews">
|
|
<summary>
|
|
Returns views collection
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocument3D.Configurations">
|
|
<summary>
|
|
Returns configurations of this document
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDocumentRepository">
|
|
<summary>
|
|
Represents the collection of documents for this application
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocumentRepository.DocumentActivated">
|
|
<summary>
|
|
Fired when document is activated
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXDocumentRepository.DocumentCreated">
|
|
<summary>
|
|
Fired when new document is created
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDocumentRepository.Active">
|
|
<summary>
|
|
Returns the pointer to active document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepository.RegisterHandler``1(System.Func{``0})">
|
|
<summary>
|
|
Registers document handler
|
|
</summary>
|
|
<param name="handlerFact">Handler factory</param>
|
|
<typeparam name="THandler"></typeparam>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepository.GetHandler``1(Xarial.XCad.Documents.IXDocument)">
|
|
<summary>
|
|
Returns the handler for this document
|
|
</summary>
|
|
<typeparam name="THandler">Handler type</typeparam>
|
|
<param name="doc">Document to get handler from</param>
|
|
<returns>Instance of the handler</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepository.PreCreate``1">
|
|
<summary>
|
|
Pre-creates a document template
|
|
</summary>
|
|
<typeparam name="TDocument">Document type to pre-create</typeparam>
|
|
<returns>Document template</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDocumentRepositoryExtension">
|
|
<summary>
|
|
Additonal methods for <see cref="T:Xarial.XCad.Documents.IXDocumentRepository"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepositoryExtension.NewPart(Xarial.XCad.Documents.IXDocumentRepository)">
|
|
<summary>
|
|
Creates new part document
|
|
</summary>
|
|
<param name="repo">This repository</param>
|
|
<returns>New part</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepositoryExtension.NewAssembly(Xarial.XCad.Documents.IXDocumentRepository)">
|
|
<summary>
|
|
Creates new assembly document
|
|
</summary>
|
|
<param name="repo">This repository</param>
|
|
<returns>New aseembly</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepositoryExtension.NewDrawing(Xarial.XCad.Documents.IXDocumentRepository)">
|
|
<summary>
|
|
Creates new drawing document
|
|
</summary>
|
|
<param name="repo">This repository</param>
|
|
<returns>New drawing</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepositoryExtension.Open(Xarial.XCad.Documents.IXDocumentRepository,System.String,Xarial.XCad.Documents.Enums.DocumentState_e)">
|
|
<summary>
|
|
Opens the specified document
|
|
</summary>
|
|
<param name="repo">Documents repository</param>
|
|
<param name="path">Path to document to open</param>
|
|
<param name="state">State of the document</param>
|
|
<returns>Opened document</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDocumentRepositoryExtension.RegisterHandler``1(Xarial.XCad.Documents.IXDocumentRepository)">
|
|
<summary>
|
|
Registers document handler with the default constructor
|
|
</summary>
|
|
<typeparam name="THandler">Handler type</typeparam>
|
|
<param name="repo">Documents repository</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDrawing">
|
|
<summary>
|
|
Represents the drawing (2D draft)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDrawing.Sheets">
|
|
<summary>
|
|
Sheets on this drawing
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDrawingView">
|
|
<summary>
|
|
Represents the drawing view on <see cref="T:Xarial.XCad.Documents.IXSheet"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDrawingView.Document">
|
|
<summary>
|
|
Contains the document referenced by this drawing view
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDrawingView.ReferencedConfiguration">
|
|
<summary>
|
|
Contains the configuration this drawing view is created from
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDrawingView.Name">
|
|
<summary>
|
|
Name of this drawing view
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXDrawingView.Location">
|
|
<summary>
|
|
Location of this drawing view
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXModelViewBasedDrawingView">
|
|
<summary>
|
|
View created from the <see cref="T:Xarial.XCad.Documents.IXModelView"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXModelViewBasedDrawingView.SourceModelView">
|
|
<summary>
|
|
Model view this drawing view is based on
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDrawingViewRepository">
|
|
<summary>
|
|
Represents the collection of drawing views
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDrawingViewRepository.PreCreate``1">
|
|
<summary>
|
|
Precreates a specific drawing view
|
|
</summary>
|
|
<typeparam name="TDrawingView">Type of drawing view to precreate</typeparam>
|
|
<returns>Drawing view template</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXDrawingViewRepositoryExtension">
|
|
<summary>
|
|
Extension methods for the <see cref="T:Xarial.XCad.Documents.IXDrawingViewRepository"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXDrawingViewRepositoryExtension.CreateModelViewBased(Xarial.XCad.Documents.IXDrawingViewRepository,Xarial.XCad.Documents.IXModelView)">
|
|
<summary>
|
|
Creates a view based on the model 3D view
|
|
</summary>
|
|
<param name="repo">Views repositry</param>
|
|
<param name="view">Model based view to create drawing view from</param>
|
|
<returns>Created drawing view</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXModelView">
|
|
<summary>
|
|
Represents the model view
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXModelView.Freeze(System.Boolean)">
|
|
<summary>
|
|
Freezes all view updates
|
|
</summary>
|
|
<param name="freeze">True to suppress all updates</param>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXModelView.Transform">
|
|
<summary>
|
|
Transformation of this view related to the model origin
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXModelView.ScreenTransform">
|
|
<summary>
|
|
Transformation of this view related to the screen coordinates
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXModelView.ScreenRect">
|
|
<summary>
|
|
View boundaries
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXModelView.ZoomToBox(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Zooms view to the specified box in XYZ model space
|
|
</summary>
|
|
<param name="box">Box to zoom to</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.IXModelView.Update">
|
|
<summary>
|
|
Refreshes the view
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXNamedView">
|
|
<summary>
|
|
Represents the view which contains name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXNamedView.Name">
|
|
<summary>
|
|
Name of the view
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXStandardView">
|
|
<summary>
|
|
Represents the one of the standard views
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXStandardView.Type">
|
|
<summary>
|
|
Type of this standard view
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.StandardViewType_e">
|
|
<summary>
|
|
Standard 3D views of the model
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Front">
|
|
<summary>
|
|
Front view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Back">
|
|
<summary>
|
|
Back view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Left">
|
|
<summary>
|
|
Left view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Right">
|
|
<summary>
|
|
Right view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Top">
|
|
<summary>
|
|
Top view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Bottom">
|
|
<summary>
|
|
Bottom view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Isometric">
|
|
<summary>
|
|
Isometric view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Trimetric">
|
|
<summary>
|
|
Trimetric view
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Documents.StandardViewType_e.Dimetric">
|
|
<summary>
|
|
Dimetric view
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXModelViewRepository">
|
|
<summary>
|
|
Represents collection of views in the <see cref="T:Xarial.XCad.Documents.IXDocument3D"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXModelViewRepository.Active">
|
|
<summary>
|
|
Gets active view
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXModelViewRepository.Item(Xarial.XCad.Documents.StandardViewType_e)">
|
|
<summary>
|
|
Returns standard view by type
|
|
</summary>
|
|
<param name="type"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXPart">
|
|
<summary>
|
|
Represents the part document
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXPart.CutListRebuild">
|
|
<summary>
|
|
Fired when cut list is regenerated
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXPart.Bodies">
|
|
<summary>
|
|
Bodies in this part document
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXSheet">
|
|
<summary>
|
|
Represents the drawing sheet
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXSheet.Name">
|
|
<summary>
|
|
Name of the sheet
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXSheet.DrawingViews">
|
|
<summary>
|
|
Drawings views on this sheet
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXSheet.Preview">
|
|
<summary>
|
|
Preview of this drawing sheet
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.IXSheetRepository">
|
|
<summary>
|
|
Represents sheets collection
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Documents.IXSheetRepository.SheetActivated">
|
|
<summary>
|
|
Fired when sheet is activated
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.IXSheetRepository.Active">
|
|
<summary>
|
|
Returns an active sheet in this sheets repository
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Services.IDocumentHandler">
|
|
<summary>
|
|
Document handler to be used in <see cref="!:IDocumentsHandler<TDocHandler>"/> documents manager
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Documents.Services.IDocumentHandler.Init(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument)">
|
|
<summary>
|
|
Called when model document is initialized (created)
|
|
</summary>
|
|
<param name="app">Pointer to application</param>
|
|
<param name="model">Pointer to this model document</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Documents.Structures.DocumentSaveArgs">
|
|
<summary>
|
|
Argument passed with <see cref="E:Xarial.XCad.Documents.IXDocument.Saving"/> event
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.Structures.DocumentSaveArgs.FileName">
|
|
<summary>
|
|
Overrides the save as file name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Documents.Structures.DocumentSaveArgs.Cancel">
|
|
<summary>
|
|
Specifies if saving operation needs to be cancelled
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Enums.ApplicationState_e">
|
|
<summary>
|
|
Represents the state of the application
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Enums.ApplicationState_e.Default">
|
|
<summary>
|
|
Default state
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Enums.ApplicationState_e.Hidden">
|
|
<summary>
|
|
Application window is not visible
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Enums.ApplicationState_e.Background">
|
|
<summary>
|
|
Application runs in the background
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Enums.ApplicationState_e.Silent">
|
|
<summary>
|
|
Application runs silently
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Enums.ApplicationState_e.Safe">
|
|
<summary>
|
|
Application runs in the safe mode
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Enums.CutListState_e">
|
|
<summary>
|
|
Represents the <see cref="P:Xarial.XCad.Features.IXCutListItem.State"/> of the cut-list
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Enums.CutListState_e.ExcludeFromBom">
|
|
<summary>
|
|
Cut-list is excluded from BOM
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Enums.TooltipArrowPosition_e">
|
|
<summary>
|
|
Position of tooltip for <see cref="!:IXApplication.ShowTooltip(string, System.Drawing.Point, Base.Enums.MessageBoxIcon_e)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Exceptions.EntityNotFoundException">
|
|
<summary>
|
|
Exception indicates that specific entity is note present within the repository
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Exceptions.EntityNotFoundException.#ctor(System.String)">
|
|
<summary>
|
|
Defaut constructor
|
|
</summary>
|
|
<param name="name">Name of the entity</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Exceptions.ICriticalException">
|
|
<summary>
|
|
Exception indicates that the error might have corrupted the current process
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Exceptions.IUserException">
|
|
<summary>
|
|
Indicates that the message of this exception can be displayed to the user
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Exceptions.MacroRunFailedException">
|
|
<summary>
|
|
Error thrown when macro cannot be run
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Exceptions.MacroRunFailedException.Path">
|
|
<summary>
|
|
Macro file path
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Exceptions.MacroRunFailedException.ErrorCode">
|
|
<summary>
|
|
Application specific error code
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Exceptions.MacroRunFailedException.#ctor(System.String,System.Int32,System.String)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
<param name="path">Path to the macro</param>
|
|
<param name="errorCode">Application specific error code</param>
|
|
<param name="err">User friendly error description</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Exceptions.MacroUserInterruptException">
|
|
<summary>
|
|
Exception indicates that macro can be forcibly terminated by the user
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Exceptions.MacroUserInterruptException.#ctor(System.String,System.Int32)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
<param name="path">Path to the macro</param>
|
|
<param name="errorCode">CAD specific error code</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Exceptions.ObjectSerializationException">
|
|
<summary>
|
|
Exception indicates an error with serialization and deserialization
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Exceptions.ObjectSerializationException.ErrorCode">
|
|
<summary>
|
|
CAD specific error code
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Exceptions.ObjectSerializationException.#ctor(System.String,System.Int32)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
<param name="message">User friendly error</param>
|
|
<param name="errCode">CAD specific error code</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Extensions.Delegates.ExtensionConnectDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.Extensions.IXExtension.Connect"/> event
|
|
</summary>
|
|
<param name="ext">Extension</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Extensions.Delegates.ExtensionDisconnectDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.Extensions.IXExtension.Disconnect"/> event
|
|
</summary>
|
|
<param name="ext">Extension</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Extensions.Delegates.ExtensionStartupCompletedDelegate">
|
|
<summary>
|
|
Delegate for <see cref="E:Xarial.XCad.Extensions.IXExtension.StartupCompleted"/> event
|
|
</summary>
|
|
<param name="ext">Extension</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Extensions.IXExtension">
|
|
<summary>
|
|
Represents the extensibility interface (add-in)
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Extensions.IXExtension.Connect">
|
|
<summary>
|
|
Event for <see cref="M:Xarial.XCad.Extensions.IXExtension.OnConnect"/>
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Extensions.IXExtension.Disconnect">
|
|
<summary>
|
|
Event for <see cref="M:Xarial.XCad.Extensions.IXExtension.OnDisconnect"/>
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.Extensions.IXExtension.StartupCompleted">
|
|
<summary>
|
|
Fired when extension startup is completed and all the components and application fully loaded
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.OnConnect">
|
|
<summary>
|
|
Called when extension is loading
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.OnDisconnect">
|
|
<summary>
|
|
Called when extension is unloading
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Extensions.IXExtension.Application">
|
|
<summary>
|
|
Pointer to the main application
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Extensions.IXExtension.CommandManager">
|
|
<summary>
|
|
Returns the instance of the commands manager
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.CreatePage``1(Xarial.XCad.UI.PropertyPage.Delegates.CreateDynamicControlsDelegate)">
|
|
<summary>
|
|
Create native property page to manage parameters
|
|
</summary>
|
|
<typeparam name="TData">Type defining the data model of the property page</typeparam>
|
|
<param name="createDynCtrlHandler">Dynamic control creation handler for properties marked with <see cref="T:Xarial.XCad.UI.PropertyPage.Attributes.DynamicControlsAttribute"/></param>
|
|
<returns>Instance of the property page</returns>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Extensions.IXExtension.Logger">
|
|
<summary>
|
|
Returns the instance of the current logger
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.CreateFeatureManagerTab``1(Xarial.XCad.Documents.IXDocument)">
|
|
<summary>
|
|
Hosts the control in the Feature Manager View
|
|
</summary>
|
|
<typeparam name="TControl">Type of control to host</typeparam>
|
|
<param name="doc">Document where to host control</param>
|
|
<returns>Custom panel</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.CreateDocumentTab``1(Xarial.XCad.Documents.IXDocument)">
|
|
<summary>
|
|
Hosts the control in the Document Tab view
|
|
</summary>
|
|
<typeparam name="TControl">Type of control to host</typeparam>
|
|
<param name="doc">Document where to host control</param>
|
|
<returns>Custom panel</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.CreatePopupWindow``1">
|
|
<summary>
|
|
Creates the popup window in the context of current application
|
|
</summary>
|
|
<typeparam name="TWindow">Window to show</typeparam>
|
|
<returns>Custom popup window</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.IXExtension.CreateTaskPane``1(Xarial.XCad.UI.TaskPane.TaskPaneSpec)">
|
|
<summary>
|
|
Hosts the control in the task pane
|
|
</summary>
|
|
<typeparam name="TControl">Type of control</typeparam>
|
|
<param name="spec">Specification of the Task Pane</param>
|
|
<returns>Custom panel</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Extensions.XApplicationExtension">
|
|
<summary>
|
|
Collection of additional functions of <see cref="T:Xarial.XCad.IXApplication"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Extensions.XApplicationExtension.ShowTooltip(Xarial.XCad.IXApplication,System.String,System.String,System.Drawing.Point,Xarial.XCad.Enums.TooltipArrowPosition_e)">
|
|
<summary>
|
|
Displays the tooltip
|
|
</summary>
|
|
<param name="app">Application</param>
|
|
<param name="title">Tooltip title</param>
|
|
<param name="msg">Tooltip content (message)</param>
|
|
<param name="pt">Tooltip position</param>
|
|
<param name="arrPos">Arrow position of the tooltip</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Attributes.CustomFeatureOptionsAttribute">
|
|
<summary>
|
|
Provides additional options for custom feature
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Attributes.CustomFeatureOptionsAttribute.#ctor(Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureOptions_e)">
|
|
<summary>
|
|
Options for macro feature
|
|
</summary>
|
|
<param name="baseName">Base name of the custom feature.
|
|
This is a default name assigned to the feature when created followed by the index</param>
|
|
<param name="flags">Additional options for custom feature</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Attributes.MissingDefinitionErrorMessage">
|
|
<summary>
|
|
Use this attribute to provide a user friendly message when definition of custom feature is not registered
|
|
</summary>
|
|
<remarks>The message might point to the download page of your extension or list a contact e-mail</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.CustomFeature.Attributes.MissingDefinitionErrorMessage.Message">
|
|
<summary>
|
|
Missing custom feature definition error message
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Attributes.MissingDefinitionErrorMessage.#ctor(System.String)">
|
|
<summary>Constructor to specify option</summary>
|
|
<param name="msg">Default message to display when custom feature cannot be loaded
|
|
The provided text is displayed in the What's Wrong dialog of</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Attributes.ParameterDimensionAttribute">
|
|
<summary>
|
|
Specifies that the current property is a dimension of the macro feature.
|
|
The value if the property is the current value of the dimension.
|
|
This property is bi-directional: it will update the value of the dimension
|
|
when changed within the <see cref="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnRebuild(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)"/>
|
|
as well as will contain the current value of the dimension when it got modified by the user in the
|
|
graphics area
|
|
</summary>
|
|
<remarks>This should only be used for numeric properties</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Attributes.ParameterDimensionAttribute.#ctor(Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureDimensionType_e)">
|
|
<summary>
|
|
Marks this property as dimension and assigns the dimension type
|
|
</summary>
|
|
<param name="dimType">Type of the dimension</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Attributes.ParameterEditBodyAttribute">
|
|
<summary>
|
|
Specifies that the current property is an edit body of the macro feature.
|
|
Edit bodies are used by macro feature if it is required to modify or replace any existing bodies.
|
|
Edit bodies will be acquire by macro feature and replaced by the <see cref="T:Xarial.XCad.Features.CustomFeature.Structures.CustomFeatureRebuildResult"/>
|
|
returned from <see cref="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnRebuild(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)"/>.
|
|
Multiple bodies are supported
|
|
</summary>
|
|
<remarks>Supported property type is IXBody
|
|
or <see cref="T:System.Collections.Generic.List`1"/> of bodies</remarks>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Attributes.ParameterExcludeAttribute">
|
|
<summary>
|
|
Indicates that this property should not be considered as macro feature parameter
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Attributes.ParametersVersionAttribute">
|
|
<summary>
|
|
Attributes specifies the current version of the macro feature parameters data model.
|
|
This allows to implement backward compatibility for the macro feature parameters
|
|
for future versions of macro feature
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Attributes.ParametersVersionAttribute.#ctor(System.Int32,System.Int32,System.Type)">
|
|
<summary>
|
|
Specifies the current version of the parameters data model
|
|
</summary>
|
|
<param name="major">Major version</param>
|
|
<param name="minor">Minor version</param>
|
|
<param name="versionConverterType">Type of the parameters converter between versions which implements
|
|
<see cref="T:Xarial.XCad.Features.CustomFeature.Services.IParametersVersionConverter"/> interface</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Attributes.ParametersVersionAttribute.#ctor(System.String,System.Type)">
|
|
<inheritdoc cref="M:Xarial.XCad.Features.CustomFeature.Attributes.ParametersVersionAttribute.#ctor(System.Int32,System.Int32,System.Type)"/>
|
|
<param name="version">Full version</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Delegates.AlignDimensionDelegate`1">
|
|
<summary>
|
|
Handler function to align specific dimension of <see cref="T:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition`1"></see> within the <see cref="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnRebuild(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)"/>/>
|
|
</summary>
|
|
<typeparam name="TData">Type of the data</typeparam>
|
|
<param name="paramName">Name of the parameter in the data model which corresponds to this dimension</param>
|
|
<param name="dim">Dimension to align</param>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureOutdateState_e.UpToDate">
|
|
<summary>
|
|
All parameters are up-to-date
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureOutdateState_e.Icons">
|
|
<summary>
|
|
Macro feature icon has changed and cannot be updated
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureOutdateState_e.Dimensions">
|
|
<summary>
|
|
Macro feature dimensions have changed and cannot be upgraded
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureUnloadReason_e">
|
|
<summary>
|
|
Reason of macro feature handler unloading. Used in <see cref="M:Xarial.XCad.Features.CustomFeature.Services.ICustomFeatureHandler.Unload(Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureUnloadReason_e)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureUnloadReason_e.ModelClosed">
|
|
<summary>
|
|
Model containing this macro feature is closed
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureUnloadReason_e.Deleted">
|
|
<summary>
|
|
This macro feature is deleted
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.IXCustomFeature">
|
|
<summary>
|
|
Instance of the custom feature
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.IXCustomFeature`1">
|
|
<summary>
|
|
Instance of the custom feature with parameters
|
|
</summary>
|
|
<typeparam name="TParams">Parameters data model</typeparam>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition">
|
|
<summary>
|
|
Represents the definition of custom feature where business logic is defined
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnEditDefinition(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)">
|
|
<summary>
|
|
Called when the Edit feature menu is clicked from the feature manager tree
|
|
</summary>
|
|
<param name="app">Pointer to the application</param>
|
|
<param name="model">Pointer to the current model where the feature resided</param>
|
|
<param name="feature">Pointer to the feature being edited</param>
|
|
<returns>Result of the editing</returns>
|
|
<remarks>Use this handler to display property manager page or any other user interface to edit feature.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnRebuild(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)">
|
|
<summary>
|
|
Called when macro feature is rebuilding
|
|
</summary>
|
|
<param name="app">Pointer to the SOLIDWORKS application</param>
|
|
<param name="model">Pointer to the document where the macro feature being rebuild</param>
|
|
<param name="feature">Pointer to the feature</param>
|
|
<returns>Result of the operation. Use static methods of <see cref="T:Xarial.XCad.Features.CustomFeature.Structures.CustomFeatureRebuildResult"/>
|
|
class to generate results</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnUpdateState(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)">
|
|
<summary>
|
|
Called when state of the feature is changed (i.e. feature is selected, moved, updated etc.)
|
|
Use this method to provide additional dynamic security options on your feature (i.e. do not allow dragging, editing etc.)
|
|
</summary>
|
|
<param name="app">Pointer to the application</param>
|
|
<param name="model">Pointer to the model where the feature resides</param>
|
|
<param name="feature">Pointer to the feature to updated state</param>
|
|
<returns>State of feature</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition`1">
|
|
<summary>
|
|
Represents the custom feature definition bound to the parameters data model
|
|
</summary>
|
|
<typeparam name="TParams"></typeparam>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition`1.OnRebuild(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature,`0,Xarial.XCad.Features.CustomFeature.Delegates.AlignDimensionDelegate{`0}@)">
|
|
<inheritdoc cref="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition.OnRebuild(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature)"/>
|
|
<param name="parameters">Current parameters of the feature</param>
|
|
<param name="alignDim">Handler to align dimensions. Use <see cref="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition`1.AlignDimension(Xarial.XCad.Annotations.IXDimension,Xarial.XCad.Geometry.Structures.Point[],Xarial.XCad.Geometry.Structures.Vector,Xarial.XCad.Geometry.Structures.Vector)"/> helper function</param>
|
|
<returns>Result of the regeneration</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition`1.AlignDimension(Xarial.XCad.Annotations.IXDimension,Xarial.XCad.Geometry.Structures.Point[],Xarial.XCad.Geometry.Structures.Vector,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Helper function to align the dimensions of the macro feature
|
|
</summary>
|
|
<param name="dim">Pointer to the dimension</param>
|
|
<param name="pts">Points of the dimension</param>
|
|
<param name="dir">Direction of the dimension</param>
|
|
<param name="extDir">Dimension extension line</param>
|
|
<remarks>Use <see cref="T:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinitionExtension"/> extension methods for more helper functions to align specific types of dimensions</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinitionExtension.AlignRadialDimension``1(Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition{``0},Xarial.XCad.Annotations.IXDimension,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Aligns the linear dimension of custom feature
|
|
</summary>
|
|
<typeparam name="TParams">Definition parameters</typeparam>
|
|
<param name="dim">Dimension to align</param>
|
|
<param name="originPt">Fixed point of the dimension</param>
|
|
<param name="normal">Normal of the entity the radial dimension is assigned to</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinitionExtension.AlignLinearDimension``1(Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition{``0},Xarial.XCad.Annotations.IXDimension,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Aligns the linear dimension of custom feature
|
|
</summary>
|
|
<typeparam name="TParams">Definition parameters</typeparam>
|
|
<param name="dim">Dimension to align</param>
|
|
<param name="originPt">Start point of the dimension (fixed point)</param>
|
|
<param name="dir">Direction of the dimnesion, i.e. entity to dimension is along this direction</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinitionExtension.AlignAngularDimension``1(Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition{``0},Xarial.XCad.Annotations.IXDimension,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Aligns the angular dimension of custom feature
|
|
</summary>
|
|
<typeparam name="TParams">Definition parameters</typeparam>
|
|
<param name="featDef">Feature definition to align dimension for</param>
|
|
<param name="dim">Dimension to align</param>
|
|
<param name="centerPt">Point at the center of the radial dimension (fixed point)</param>
|
|
<param name="refPt">Reference point of the radial dimension (fixed point)</param>
|
|
<param name="rotVec">Vector, normal to the radial dimension extension line</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Services.ICustomFeatureHandler">
|
|
<summary>
|
|
Handler of each macro feature
|
|
</summary>
|
|
<remarks>The instance of the specific class will be created for each macro feature</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Services.ICustomFeatureHandler.Init(Xarial.XCad.IXApplication,Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.IXFeature)">
|
|
<summary>
|
|
Called when macro feature is created or loaded first time
|
|
</summary>
|
|
<param name="app">Pointer to application</param>
|
|
<param name="model">Pointer to model</param>
|
|
<param name="feat">Pointer to feature</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Services.ICustomFeatureHandler.Unload(Xarial.XCad.Features.CustomFeature.Enums.CustomFeatureUnloadReason_e)">
|
|
<summary>
|
|
Called when macro feature is deleted or model is closed
|
|
</summary>
|
|
<param name="reason">Reason of macro feature unload</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Services.IParametersVersionConverter">
|
|
<summary>
|
|
Mechanism allowing to support backward compatibility of the macro feature parameters across the versions.
|
|
This interface is coupled with <see cref="T:Xarial.XCad.Features.CustomFeature.Attributes.ParametersVersionAttribute"/>
|
|
</summary>
|
|
<remarks>This class is a dictionary of version and the appropriate converter from the previous version to
|
|
the specified one. Use <see cref="T:Xarial.XCad.Features.CustomFeature.Services.ParametersVersionConverter"/> for the specific implementation</remarks>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Services.ParametersVersionConverter">
|
|
<summary>
|
|
Specific implementation of <see cref="T:Xarial.XCad.Features.CustomFeature.Services.IParametersVersionConverter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Services.IParameterConverter">
|
|
<summary>
|
|
Represents the conversion routines between this version of parameters and previous version of the parameters
|
|
</summary>
|
|
<remarks>Use specific implementation <see cref="T:Xarial.XCad.Features.CustomFeature.Services.ParameterConverter"/></remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Services.IParameterConverter.ConvertEditBodies(Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature,Xarial.XCad.Geometry.IXBody[])">
|
|
<summary>
|
|
Converts edit bodies from previous version
|
|
</summary>
|
|
<param name="model">Pointer to current model</param>
|
|
<param name="feat">Pointer to current feature</param>
|
|
<param name="editBodies">Array of edit bodies form the previous version of parameters</param>
|
|
<returns>Array of new bodies in the new version of macro feature</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Services.IParameterConverter.ConvertDisplayDimensions(Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature,Xarial.XCad.Annotations.IXDimension[])">
|
|
<summary>
|
|
Converts display dimensions from previous version
|
|
</summary>
|
|
<param name="model">Pointer to current model</param>
|
|
<param name="feat">Pointer to current feature</param>
|
|
<param name="dispDims">Array of display dimensions from the previous version</param>
|
|
<returns>Array of display dimensions in the new version of macro feature</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Services.IParameterConverter.ConvertParameters(Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Converts parameters from previous version
|
|
</summary>
|
|
<param name="model">Pointer to current model</param>
|
|
<param name="feat">Pointer to current feature</param>
|
|
<param name="parameters">Dictionary of parameter names and values</param>
|
|
<returns>Parameters for the new version</returns>
|
|
<remarks>Parameters list also contains the indices for the objects in macro feature (edit bodies, selection, dimensions)</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.CustomFeature.Services.IParameterConverter.ConvertSelections(Xarial.XCad.Documents.IXDocument,Xarial.XCad.Features.CustomFeature.IXCustomFeature,Xarial.XCad.IXSelObject[])">
|
|
<summary>
|
|
Converts selections from previous version
|
|
</summary>
|
|
<param name="model">Pointer to current model</param>
|
|
<param name="feat">Pointer to current feature</param>
|
|
<param name="selection">Array of selections from previous version</param>
|
|
<returns>Selections correspond to new version of macro feature</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.CustomFeature.Services.ParameterConverter">
|
|
<inheritdoc/>
|
|
<summary>
|
|
Specific implementation of <see cref="T:Xarial.XCad.Features.CustomFeature.Services.IParameterConverter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXCoordinateSystem">
|
|
<summary>
|
|
Represents the coordinate system feature
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXCoordinateSystem.Transform">
|
|
<summary>
|
|
Transformation of this coordinate system
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXCutListItem">
|
|
<summary>
|
|
Represents the cut-list item feature
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXCutListItem.State">
|
|
<summary>
|
|
State of this cut-list item
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXCutListItem.Bodies">
|
|
<summary>
|
|
Bodies of this cut-list item
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXCutListItemExtension">
|
|
<summary>
|
|
Additional methods of <see cref="T:Xarial.XCad.Features.IXCutListItem"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.IXCutListItemExtension.Quantity(Xarial.XCad.Features.IXCutListItem)">
|
|
<summary>
|
|
Gets the quantity of this cut-list-item
|
|
</summary>
|
|
<param name="item">Input item</param>
|
|
<returns>Quantity</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXFeature">
|
|
<summary>
|
|
Represents all features in the Feature Manager Design Tree
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXFeature.Name">
|
|
<summary>
|
|
Name of the feature
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXFeature.Dimensions">
|
|
<summary>
|
|
Dimensions associated with the feature
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXFeatureRepository">
|
|
<summary>
|
|
Represents collection of features in the document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.IXFeatureRepository.PreCreateCustomFeature">
|
|
<summary>
|
|
Pre-creates custom feature
|
|
</summary>
|
|
<returns>Instance of custom feature</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.IXFeatureRepository.PreCreateCustomFeature``1">
|
|
<summary>
|
|
Pre-creates custom feature with specific parameters
|
|
</summary>
|
|
<typeparam name="TParams">Type of parameters managed by this custom feature</typeparam>
|
|
<returns>Instance of custom feature</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.IXFeatureRepository.CreateCustomFeature``3">
|
|
<summary>
|
|
Creates a custom feature with built-in editor for the property page
|
|
</summary>
|
|
<typeparam name="TDef">Definition of the custom feature</typeparam>
|
|
<typeparam name="TParams">Type which defines the data structure of the custom feature</typeparam>
|
|
<typeparam name="TPage">Type which defines the data model for the property page</typeparam>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.IXFeatureRepository.PreCreate2DSketch">
|
|
<summary>
|
|
Creates a template for 2D sketch
|
|
</summary>
|
|
<returns>2D sketch template</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Features.IXFeatureRepository.PreCreate3DSketch">
|
|
<summary>
|
|
Creates a template for 3D sketch
|
|
</summary>
|
|
<returns>2D sketch template</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXPlane">
|
|
<summary>
|
|
Represents the plane reference geometry
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXPlane.Definition">
|
|
<summary>
|
|
Definition of this plane
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXSketch2D">
|
|
<summary>
|
|
Represents specific 2D sketch
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXSketch2D.Regions">
|
|
<summary>
|
|
Regions in this 2D sketch
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXSketch2D.Plane">
|
|
<summary>
|
|
Returns the plane of this sketch
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXSketch3D">
|
|
<summary>
|
|
Represents specific 3D sketch
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXSketchBase">
|
|
<summary>
|
|
Represents the base sketch 2D or 3D
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXSketchBase.IsEditing">
|
|
<summary>
|
|
Identifies if this sketch is currently under editing
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Features.IXSketchBase.Entities">
|
|
<summary>
|
|
List of sketch entitites (segments and points)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Features.IXSketchRegion">
|
|
<summary>
|
|
Represents sketch region (closed contour)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Curves.IXCurve">
|
|
<summary>
|
|
Represents the curve
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXBody">
|
|
<summary>
|
|
Represents the body object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXBody.Name">
|
|
<summary>
|
|
Name of the body
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXBody.Visible">
|
|
<summary>
|
|
Is body visible
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXBody.Add(Xarial.XCad.Geometry.IXBody)">
|
|
<summary>
|
|
Boolean add operation on body
|
|
</summary>
|
|
<param name="other">Other body</param>
|
|
<returns>Resulting body</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXBody.Substract(Xarial.XCad.Geometry.IXBody)">
|
|
<summary>
|
|
Boolean substract operation
|
|
</summary>
|
|
<param name="other">Body to substract</param>
|
|
<returns>Resulting bodies</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXBody.Common(Xarial.XCad.Geometry.IXBody)">
|
|
<summary>
|
|
Boolean common operation
|
|
</summary>
|
|
<param name="other">Body to get common with</param>
|
|
<returns>Resulting body</returns>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXBody.Faces">
|
|
<summary>
|
|
Enumerates all faces of this body
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXBody.Edges">
|
|
<summary>
|
|
Enumerates all edges of this body
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXSheetBody">
|
|
<summary>
|
|
Represents sheet (surface) body
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXPlanarSheetBody">
|
|
<summary>
|
|
Subtype of <see cref="T:Xarial.XCad.Geometry.IXSheetBody"/> which is planar
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXSolidBody">
|
|
<summary>
|
|
Represents solid body geometry
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXSolidBody.Volume">
|
|
<summary>
|
|
Volume of this solid body
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXBodyRepository">
|
|
<summary>
|
|
Represents the collection of bodies
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXBoundingBox">
|
|
<summary>
|
|
Represents the bounding box of the geometrical object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXBoundingBox.Box">
|
|
<summary>
|
|
Bounding box data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXBoundingBox.Precise">
|
|
<summary>
|
|
True to calculate precise bounding box, false to calculate approximate bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXAssemblyBoundingBox">
|
|
<summary>
|
|
Bounding box specific to the assembly
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXEdge">
|
|
<summary>
|
|
Represents an edge element of the geometry
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXEdge.Definition">
|
|
<summary>
|
|
Underlyining segment defining this edge
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXCircularEdge">
|
|
<summary>
|
|
Represents specific circular edge
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXCircularEdge.Definition">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXLinearEdge">
|
|
<summary>
|
|
Represents specific linear edge
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXLinearEdge.Definition">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXFace">
|
|
<summary>
|
|
Represents face entity
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXFace.Area">
|
|
<summary>
|
|
Area of the face
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXFace.Definition">
|
|
<summary>
|
|
Underlying definition for this face
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXPlanarFace">
|
|
<summary>
|
|
Represents planar face
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXPlanarFace.Definition">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXCylindricalFace">
|
|
<summary>
|
|
Represents cylindrical face
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXCylindricalFace.Definition">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXGeometryBuilder">
|
|
<summary>
|
|
Provides access to geometry buidling functions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXGeometryBuilder.WireBuilder">
|
|
<summary>
|
|
Provides an access to wire geometry builder functions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXGeometryBuilder.SheetBuilder">
|
|
<summary>
|
|
Provides an access to sheet geometry builder functions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXGeometryBuilder.SolidBuilder">
|
|
<summary>
|
|
Provides an access to solid geometry builder functions
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXMemoryGeometryBuilder">
|
|
<summary>
|
|
Geometry builder for building in-memory geometry objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXMemoryGeometryBuilder.DeserializeBody(System.IO.Stream)">
|
|
<summary>
|
|
Deserializes memory body from the stream
|
|
</summary>
|
|
<param name="stream">Stream to deserialize body from</param>
|
|
<returns>Deserialized body</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXMemoryGeometryBuilder.SerializeBody(Xarial.XCad.Geometry.IXBody,System.IO.Stream)">
|
|
<summary>
|
|
Serializes body into the stream
|
|
</summary>
|
|
<param name="body">Body to store</param>
|
|
<param name="stream">Stream to store to</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXGeometryBuilderExtension.CreateSolidBox(Xarial.XCad.Geometry.IXGeometryBuilder,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector,Xarial.XCad.Geometry.Structures.Vector,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Creates a box body from the specified parameters
|
|
</summary>
|
|
<param name="builder">Geometry builder</param>
|
|
<param name="center">Center of the box base face</param>
|
|
<param name="dir">Direction of the box</param>
|
|
<param name="refDir">Reference direction of the box base face (this is the vector perpendicular to 'dir'</param>
|
|
<param name="width">Width of the box. This size is parallel to 'refDir' vector</param>
|
|
<param name="length">Length of the box</param>
|
|
<param name="height">Height of the box. THis size is parallel to 'dir' vector</param>
|
|
<returns>Box extrusion</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXGeometryBuilderExtension.CreateSolidCylinder(Xarial.XCad.Geometry.IXGeometryBuilder,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector,System.Double,System.Double)">
|
|
<summary>
|
|
Creates cylindrical extrusion from input parameters
|
|
</summary>
|
|
<param name="builder">Geometry builder</param>
|
|
<param name="center">Center of the cylinder base</param>
|
|
<param name="axis">Direction of the cylinder</param>
|
|
<param name="radius">Radius of the cylinder</param>
|
|
<param name="height">Height of the cylinder</param>
|
|
<returns>Cylindrical extrusion</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.IXGeometryBuilderExtension.CreateSolidCone(Xarial.XCad.Geometry.IXGeometryBuilder,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector,System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Create a conical revolve body
|
|
</summary>
|
|
<param name="builder">Geometry builder</param>
|
|
<param name="center">Center of the cone base</param>
|
|
<param name="axis">Cone axis</param>
|
|
<param name="baseDiam">Base diameter of the cone</param>
|
|
<param name="topDiam">Top diameter of the cone</param>
|
|
<param name="height">Height of the cone</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXMassProperty">
|
|
<summary>
|
|
Evaluates mass properties of the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.CenterOfGravity">
|
|
<summary>
|
|
Center of Gravity
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.SurfaceArea">
|
|
<summary>
|
|
Surface area
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.Volume">
|
|
<summary>
|
|
Volume
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.Mass">
|
|
<summary>
|
|
Mass
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.Density">
|
|
<summary>
|
|
Density
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.PrincipalAxesOfInertia">
|
|
<summary>
|
|
Principal axes of inertia
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.PrincipalMomentOfInertia">
|
|
<summary>
|
|
Principal moment of inertia
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.IXMassProperty.MomentOfInertia">
|
|
<summary>
|
|
Moment of inertia
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.IXAssemblyMassProperty">
|
|
<summary>
|
|
Evaluates mass properties of the assembly
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Primitives.IXPrimitive">
|
|
<summary>
|
|
Represents the 3D geometry of a primitive
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Primitives.IXPrimitive.Bodies">
|
|
<summary>
|
|
Bodies associated with this primitive
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Structures.Box3D">
|
|
<summary>
|
|
Represents the 3D bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.Width">
|
|
<summary>
|
|
Width of the bounding box relative to X axis
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.Height">
|
|
<summary>
|
|
Width of the bounding box relative to Y axis
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.Length">
|
|
<summary>
|
|
Width of the bounding box relative to Z axis
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.CenterPoint">
|
|
<summary>
|
|
Center point of the bounding box
|
|
</summary>
|
|
<remarks>This is the center point of the diagonal</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.AxisX">
|
|
<summary>
|
|
X axis of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.AxisY">
|
|
<summary>
|
|
Y axis of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Box3D.AxisZ">
|
|
<summary>
|
|
Z axis of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3D.#ctor(System.Double,System.Double,System.Double,Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector,Xarial.XCad.Geometry.Structures.Vector,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Structures.Box3DExtension">
|
|
<summary>
|
|
Additional methods for <see cref="T:Xarial.XCad.Geometry.Structures.Box3D"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetLeftBottomFront(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Left-Bottom-Front point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetLeftBottomBack(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Left-Bottom-Back point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetLeftTopFront(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Left-Top-Front point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetLeftTopBack(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Left-Top-Back point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetRightBottomFront(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Right-Bottom-Front point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetRightBottomBack(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Right-Bottom-Back point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetRightTopFront(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Right-Top-Front point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Box3DExtension.GetRightTopBack(Xarial.XCad.Geometry.Structures.Box3D)">
|
|
<summary>
|
|
Right-Top-Back point of the bounding box
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Structures.Point">
|
|
<summary>
|
|
Structure representing 3D point
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Point.X">
|
|
<summary>
|
|
X coordinate
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Point.Y">
|
|
<summary>
|
|
Y coordinate
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Structures.Point.Z">
|
|
<summary>
|
|
Z coordinate
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.#ctor(System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Creates point by 3 coordinates
|
|
</summary>
|
|
<param name="x">X coordinate</param>
|
|
<param name="y">Y coordinate</param>
|
|
<param name="z">Z coordinate</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.#ctor(System.Double[])">
|
|
<summary>
|
|
Creates coordinate from the array of points
|
|
</summary>
|
|
<param name="pt">Array of 3 coordinates of the point</param>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when input array is null</exception>
|
|
<exception cref="T:System.ArgumentException">Thrown when size of the input array doesn't equal to 3</exception>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.ToArray">
|
|
<summary>
|
|
Converts the point to an array of 3 coordinates
|
|
</summary>
|
|
<returns>Array of coordinates</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.IsSame(Xarial.XCad.Geometry.Structures.Point)">
|
|
<summary>
|
|
Compares two points coordinates by exact values
|
|
</summary>
|
|
<param name="pt">Point to compare</param>
|
|
<returns>Result of comparison</returns>
|
|
<exception cref="T:System.ArgumentNullException"/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.IsSame(System.Double,System.Double,System.Double)">
|
|
<summary>
|
|
Compares the coordinates of this point to specified values
|
|
</summary>
|
|
<param name="x">X coordinate</param>
|
|
<param name="y">Y coordinate</param>
|
|
<param name="z">Z coordinate</param>
|
|
<returns>True if coordinates are equal</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.op_Subtraction(Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Point)">
|
|
<summary>
|
|
Deducts one point of another resulting in vector
|
|
</summary>
|
|
<param name="pt1">First point</param>
|
|
<param name="pt2">Second point</param>
|
|
<returns>Vector</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.op_Addition(Xarial.XCad.Geometry.Structures.Point,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Moves point along the vector
|
|
</summary>
|
|
<param name="pt">Point to move</param>
|
|
<param name="vec">Direction of move</param>
|
|
<returns>New point</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.Move(Xarial.XCad.Geometry.Structures.Vector,System.Double)">
|
|
<summary>
|
|
Moves the point along the vector by specified distance
|
|
</summary>
|
|
<param name="dir">Direction of move</param>
|
|
<param name="dist">Distance</param>
|
|
<returns>New point</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Point.Scale(System.Double)">
|
|
<summary>
|
|
Scales the position
|
|
</summary>
|
|
<param name="scalar">Scalar value</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Structures.Vector">
|
|
<inheritdoc/>
|
|
<summary>
|
|
Represents the vector
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.#ctor(System.Double,System.Double,System.Double)">
|
|
<inheritdoc cref="M:Xarial.XCad.Geometry.Structures.Point.#ctor(System.Double,System.Double,System.Double)"/>
|
|
<summary>
|
|
Creates vector by 3 coordinates
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.#ctor(System.Double[])">
|
|
<summary>
|
|
Creates vector by direction
|
|
</summary>
|
|
<param name="dir">Direction of vector</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.#ctor(Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Creates vector by as a copy of another vector
|
|
</summary>
|
|
<param name="vec">Vector to copy</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.IsSame(Xarial.XCad.Geometry.Structures.Vector,System.Boolean)">
|
|
<summary>
|
|
Compares the vectors
|
|
</summary>
|
|
<param name="vec">Another vector</param>
|
|
<param name="normilize">Normalized vectors while comparison</param>
|
|
<returns>True if vectors are the same</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.Normalize">
|
|
<summary>
|
|
Normalizes the vector
|
|
</summary>
|
|
<returns>New normalized vector</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.Cross(Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Creates a cross product of this vector with another vector
|
|
</summary>
|
|
<param name="vector">Another vector</param>
|
|
<returns>New cross product vector</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.GetLength">
|
|
<summary>
|
|
Returns the length of this vector
|
|
</summary>
|
|
<returns>Vector length</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.Vector.Dot(Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Calculates the dot product between vectors
|
|
</summary>
|
|
<param name="vector">Other vector</param>
|
|
<returns>Scalar dot product</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Structures.VectorExtension">
|
|
<summary>
|
|
Additional methods for the vector
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.VectorExtension.CreateAnyPerpendicular(Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Creates perpendicular vector
|
|
</summary>
|
|
<param name="dir">Vector to base on</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Geometry.Structures.VectorExtension.GetAngle(Xarial.XCad.Geometry.Structures.Vector,Xarial.XCad.Geometry.Structures.Vector)">
|
|
<summary>
|
|
Finds the angle between vectors
|
|
</summary>
|
|
<param name="thisVec">First vector</param>
|
|
<param name="otherVec">Other vector</param>
|
|
<returns>Angle in radians</returns>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Surfaces.IXCylindricalSurface.Origin">
|
|
<summary>
|
|
Origin of the cylindrical face
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Surfaces.IXCylindricalSurface.Axis">
|
|
<summary>
|
|
Cylinder axis
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Surfaces.IXCylindricalSurface.Radius">
|
|
<summary>
|
|
Radius of cylindrical face
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Geometry.Wires.IXSegment">
|
|
<summary>
|
|
Segment represents the definition of any wire body
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Wires.IXSegment.StartPoint">
|
|
<summary>
|
|
Start point of this sketch segment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Wires.IXSegment.EndPoint">
|
|
<summary>
|
|
End point of this sketch segment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Geometry.Wires.IXSegment.Length">
|
|
<summary>
|
|
Length of the segment
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXApplication">
|
|
<summary>
|
|
Top level object in the class hierarchy
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.IXApplication.Starting">
|
|
<summary>
|
|
Fires when application is starting
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.Version">
|
|
<summary>
|
|
Version of the application
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.State">
|
|
<summary>
|
|
State of the application
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.IsAlive">
|
|
<summary>
|
|
Checks if this application is alive
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.WindowRectangle">
|
|
<summary>
|
|
Returns the rectangle of the application window
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.WindowHandle">
|
|
<summary>
|
|
Window handle of the application main window
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.Process">
|
|
<summary>
|
|
Application process
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.Documents">
|
|
<summary>
|
|
Accesses the documents repository
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXApplication.MemoryGeometryBuilder">
|
|
<summary>
|
|
Accesses memory geometry builder to build primitive wires, surface and solids
|
|
</summary>
|
|
<remarks>Usually used in the <see cref="T:Xarial.XCad.Features.CustomFeature.IXCustomFeatureDefinition"/></remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXApplication.ShowMessageBox(System.String,Xarial.XCad.Base.Enums.MessageBoxIcon_e,Xarial.XCad.Base.Enums.MessageBoxButtons_e)">
|
|
<summary>
|
|
Displays the message box
|
|
</summary>
|
|
<param name="msg">Message to display</param>
|
|
<param name="icon">Message box icon</param>
|
|
<param name="buttons">Message box buttons</param>
|
|
<returns>Button clicked by the user</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXApplication.ShowTooltip(Xarial.XCad.Base.ITooltipSpec)">
|
|
<summary>
|
|
Displays the modeless tooltip
|
|
</summary>
|
|
<param name="spec">Specification of the tooltip</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXApplication.OpenMacro(System.String)">
|
|
<summary>
|
|
Create instance of the macro
|
|
</summary>
|
|
<param name="path">Full path to the macro</param>
|
|
<returns>Instance of the macro</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXApplication.CreateProgress">
|
|
<summary>
|
|
Initiates the displaying of progress in the application
|
|
</summary>
|
|
<returns>Pointer to progress manager</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXApplication.Close">
|
|
<summary>
|
|
Close current instance of the application
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXColorizable">
|
|
<summary>
|
|
Identifies the visual object which can have color
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXColorizable.Color">
|
|
<summary>
|
|
Color of visual object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXMacroExtension">
|
|
<summary>
|
|
Additional methods of <see cref="T:Xarial.XCad.IXMacro"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXMacroExtension.Run(Xarial.XCad.IXMacro)">
|
|
<summary>
|
|
Run macro with default entry point and default options
|
|
</summary>
|
|
<param name="macro">Macro to run</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXMacroExtension.Run(Xarial.XCad.IXMacro,Xarial.XCad.Enums.MacroRunOptions_e)">
|
|
<summary>
|
|
Run macro with default entry point and specified options
|
|
</summary>
|
|
<param name="macro">Macro to run</param>
|
|
<param name="opts">macro options</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXMacroExtension.Run(Xarial.XCad.IXMacro,Xarial.XCad.Structures.MacroEntryPoint)">
|
|
<summary>
|
|
Run macro with specirfied entry point and default options
|
|
</summary>
|
|
<param name="macro">Macro to run</param>
|
|
<param name="entryPoint">Entry point</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXObject">
|
|
<summary>
|
|
Wrapper inteface over the specific object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXObject.IsAlive">
|
|
<summary>
|
|
Identifies if current object is valid
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXObject.Tags">
|
|
<summary>
|
|
Provides an ability to store temp tags in this session
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXObject.Serialize(System.IO.Stream)">
|
|
<summary>
|
|
Saves this object into a stream
|
|
</summary>
|
|
<param name="stream">Target stream</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXObjectContainer">
|
|
<summary>
|
|
Represents the environment which can contain objects in different states (e.g. component, document, drawing view)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXObjectContainer.ConvertObject``1(``0)">
|
|
<summary>
|
|
Converts pointer to object to the current environment container
|
|
</summary>
|
|
<typeparam name="TSelObject">Type of object</typeparam>
|
|
<param name="obj">Pointer to object to convert</param>
|
|
<returns>Converted pointer</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXProgress">
|
|
<summary>
|
|
Enables the display of progress bar and status
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXProgress.SetStatus(System.String)">
|
|
<summary>
|
|
Sets status of the operation
|
|
</summary>
|
|
<param name="status">Status messae</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXSelObject">
|
|
<summary>
|
|
Represents objects which can be selected by the user
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXSelObject.IsSelected">
|
|
<summary>
|
|
Identifies if this object is currently selected
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXSelObject.Select(System.Boolean)">
|
|
<summary>
|
|
Selects object in the document
|
|
</summary>
|
|
<param name="append">True to add selection to the current list, false to clear existing selection</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXServiceCollection">
|
|
<summary>
|
|
Collection of services
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXServiceCollection.Services">
|
|
<summary>
|
|
Registered services
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollection.AddOrReplace(System.Type,System.Func{System.Object})">
|
|
<summary>
|
|
Adds new service or replaces existing one
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollection.CreateProvider">
|
|
<summary>
|
|
Creates service provider from this service
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXServiceCollectionExtension">
|
|
<summary>
|
|
Extension methods of <see cref="T:Xarial.XCad.IXServiceCollection"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollectionExtension.AddOrReplace``2(Xarial.XCad.IXServiceCollection)">
|
|
<inheritdoc cref="M:Xarial.XCad.IXServiceCollection.AddOrReplace(System.Type,System.Func{System.Object})"/>
|
|
<param name="coll">Services collection</param>
|
|
<typeparam name="TService">Service interface</typeparam>
|
|
<typeparam name="TImplementation">Service implementation</typeparam>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollectionExtension.AddOrReplace``1(Xarial.XCad.IXServiceCollection,System.Func{``0})">
|
|
<inheritdoc cref="M:Xarial.XCad.IXServiceCollectionExtension.AddOrReplace``2(Xarial.XCad.IXServiceCollection)"/>
|
|
<param name="factory">Service creation factory</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollectionExtension.AddOrReplace(Xarial.XCad.IXServiceCollection,System.Type,System.Type)">
|
|
<inheritdoc cref="M:Xarial.XCad.IXServiceCollection.AddOrReplace(System.Type,System.Func{System.Object})"/>
|
|
<param name="svcType">Type of service</param>
|
|
<param name="impType">Service implementation</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollectionExtension.AddOrReplace(Xarial.XCad.IXServiceCollection,System.Type,System.Func{System.Object})">
|
|
<inheritdoc cref="M:Xarial.XCad.IXServiceCollectionExtension.AddOrReplace(Xarial.XCad.IXServiceCollection,System.Type,System.Type)"/>
|
|
<param name="factory">Service creation factory</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceCollectionExtension.Merge(Xarial.XCad.IXServiceCollection,Xarial.XCad.IXServiceCollection)">
|
|
<summary>
|
|
Merges two service collections
|
|
</summary>
|
|
<param name="svc">Target service</param>
|
|
<param name="other">Service to merge with (will override services if exist)</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXServiceConsumer">
|
|
<summary>
|
|
Declares that this object consumes services
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.IXServiceConsumer.ConfigureServices">
|
|
<summary>
|
|
Event for <see cref="M:Xarial.XCad.IXServiceConsumer.OnConfigureServices(Xarial.XCad.IXServiceCollection)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXServiceConsumer.OnConfigureServices(Xarial.XCad.IXServiceCollection)">
|
|
<summary>
|
|
Allows to configure services of the object
|
|
</summary>
|
|
<param name="collection">Collection of services</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXVersion">
|
|
<summary>
|
|
Represents the version of the application or file
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.IXVersion.DisplayName">
|
|
<summary>
|
|
Display name of this version
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.VersionEquality_e">
|
|
<summary>
|
|
Versions equality result
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.VersionEquality_e.Same">
|
|
<summary>
|
|
Versions are the same
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.VersionEquality_e.Older">
|
|
<summary>
|
|
This version is older to the version it is compared to
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.VersionEquality_e.Newer">
|
|
<summary>
|
|
This version is newer to the version it is compared to
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.IXVersionExtension">
|
|
<summary>
|
|
Additional methods for version
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.IXVersionExtension.Compare``1(``0,``0)">
|
|
<summary>
|
|
Compares two versions
|
|
</summary>
|
|
<typeparam name="TVersion">Type of the version to compare</typeparam>
|
|
<param name="vers">This version</param>
|
|
<param name="other">Version to compare to</param>
|
|
<returns>Result of comparison</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Properties.Resources">
|
|
<summary>
|
|
A strongly-typed resource class, for looking up localized strings, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Properties.Resources.ResourceManager">
|
|
<summary>
|
|
Returns the cached ResourceManager instance used by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Properties.Resources.Culture">
|
|
<summary>
|
|
Overrides the current thread's CurrentUICulture property for all
|
|
resource lookups using this strongly typed resource class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Properties.Resources.default_icon">
|
|
<summary>
|
|
Looks up a localized resource of type System.Byte[].
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Reflection.EnumExtension.TryGetAttribute``1(System.Enum,System.Action{``0})">
|
|
<summary>
|
|
Tries to get attribute from the enumeration
|
|
</summary>
|
|
<typeparam name="TAtt">Type of attribute to get</typeparam>
|
|
<param name="enumer">Enumerator value</param>
|
|
<param name="attProc">Action to process attribute</param>
|
|
<returns>True if attribute exists</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Reflection.ResourceHelper">
|
|
<summary>
|
|
Helper class to work with resources
|
|
</summary>
|
|
<remarks>Use this method in attributes to provide the reference to the data from the resources (i.e. text and image)</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Reflection.ResourceHelper.GetResource``1(System.Type,System.String)">
|
|
<summary>
|
|
Gets the specified resource by name
|
|
</summary>
|
|
<typeparam name="T">Type of the resource</typeparam>
|
|
<param name="resType">Type of the resource class (usually Resources)</param>
|
|
<param name="resName">Name of the resource</param>
|
|
<returns>Value of the resource</returns>
|
|
<remarks>Use nameof operator to get the resource name avoiding using the 'magic' strings</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Reflection.TypeExtension.TryGetAttribute``1(System.Type,System.Action{``0})">
|
|
<summary>
|
|
Attempts to get the attribute from the type, all parent types and interfaces
|
|
</summary>
|
|
<typeparam name="TAtt">Type of the attribute</typeparam>
|
|
<param name="type">Type to get attribute from</param>
|
|
<param name="attProc">Handler to process the attribute</param>
|
|
<returns>True if attribute exists</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Sketch.IXSketchEntity">
|
|
<summary>
|
|
Represents generic sketch entity (e.g. line, point, arc, etc.)
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Sketch.IXSketchSegment">
|
|
<summary>
|
|
Represents the sketch segmetn element
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Sketch.IXSketchSegment.Definition">
|
|
<summary>
|
|
Underlyining segment defining this sketch segment
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.Structures.MacroEntryPoint">
|
|
<summary>
|
|
Represents the entty point of the macro
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Structures.MacroEntryPoint.ModuleName">
|
|
<summary>
|
|
Module name for the entry point
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.Structures.MacroEntryPoint.ProcedureName">
|
|
<summary>
|
|
Name of the procedure defined as an entry point
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.Structures.MacroEntryPoint.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Default constructor for entry point
|
|
</summary>
|
|
<param name="moduleName">Module name</param>
|
|
<param name="procName">Procedure name</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Commands.Attributes.CommandGroupInfoAttribute">
|
|
<summary>
|
|
Provides the additional information about the command group
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.Attributes.CommandGroupInfoAttribute.#ctor(System.Int32)">
|
|
<summary>
|
|
Constructor for specifying the additional information for group
|
|
</summary>
|
|
<param name="userId">User id for the command group. Must be unique per add-in</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Commands.Attributes.CommandGroupParentAttribute">
|
|
<summary>
|
|
Associates the parent group for this group
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.Attributes.CommandGroupParentAttribute.#ctor(System.Int32)">
|
|
<param name="parentGroupUserId">User id of the parent group</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.Attributes.CommandGroupParentAttribute.#ctor(System.Type)">
|
|
<param name="parentGroupType">Type of the parent group enumeration</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute">
|
|
<summary>
|
|
Provides additional information about the item command
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute.#ctor(Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e)">
|
|
<summary>
|
|
Constructor for specifying additional information about command item
|
|
</summary>
|
|
<param name="suppWorkspaces">Indicates the workspaces where this command is enabled. This information is used in the default command enable handler</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute.#ctor(System.Boolean,System.Boolean,Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e)">
|
|
<inheritdoc cref="M:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute.#ctor(Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e)"/>
|
|
<param name="hasMenu">Indicates if this command should be displayed in the menu</param>
|
|
<param name="hasToolbar">Indicates if this command should be displayed in the toolbar</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute.#ctor(System.Boolean,System.Boolean,Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e,System.Boolean,Xarial.XCad.UI.Commands.Enums.RibbonTabTextDisplay_e)">
|
|
<inheritdoc cref="M:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute.#ctor(System.Boolean,System.Boolean,Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e)"/>
|
|
<param name="showInCmdTabBox">Indicates that this command should be added to command tab box in command manager (ribbon)</param>
|
|
<param name="textStyle">Text display type for command in command tab box. This option is applicable when 'showInCmdTabBox' is set to true</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Commands.Attributes.CommandSpacerAttribute">
|
|
<summary>
|
|
Marks the command to be separated by the spacer (separator) in the menu and the toolbar
|
|
</summary>
|
|
<remarks>Spacer is added before the command marked with this attribute</remarks>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e">
|
|
<summary>
|
|
Provides the enumeration of various workspaces
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e.NoDocuments">
|
|
<summary>
|
|
Environment when no documents are loaded
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e.Part">
|
|
<summary>
|
|
Part document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e.Assembly">
|
|
<summary>
|
|
Assembly document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e.Drawing">
|
|
<summary>
|
|
Drawing document
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e.AllDocuments">
|
|
<summary>
|
|
All SOLIDWORKS documents
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.Commands.Enums.WorkspaceTypes_e.All">
|
|
<summary>
|
|
All environments
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Commands.IXCommandGroup">
|
|
<summary>
|
|
Represents the group of commands
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.Commands.IXCommandGroup.CommandClick">
|
|
<summary>
|
|
Event raised when the specific command button is clicked
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.Commands.IXCommandGroup.CommandStateResolve">
|
|
<summary>
|
|
Event raised when it is required to resolve the state of the button as condition has changed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.Commands.IXCommandGroup.Spec">
|
|
<summary>
|
|
Specification of the group
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.IXCommandManagerExtension.AddCommandGroup``1(Xarial.XCad.UI.Commands.IXCommandManager)">
|
|
<summary>
|
|
Adds command group based on the enumeration where each enumeration field represents the command button
|
|
</summary>
|
|
<typeparam name="TCmdEnum">Enumeration with commands</typeparam>
|
|
<param name="cmdMgr">Command manager</param>
|
|
<returns>Created command group</returns>
|
|
<remarks>Decorate enumeration and fields with <see cref="T:Xarial.XCad.Base.Attributes.TitleAttribute"/>, <see cref="T:Xarial.XCad.Base.Attributes.IconAttribute"/>, <see cref="T:System.ComponentModel.DescriptionAttribute"/>, <see cref="T:Xarial.XCad.UI.Commands.Attributes.CommandItemInfoAttribute"/> to customized look and feel of commands</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Commands.IXCommandManagerExtension.AddContextMenu``1(Xarial.XCad.UI.Commands.IXCommandManager,System.Nullable{Xarial.XCad.Base.Enums.SelectType_e})">
|
|
<summary>
|
|
Adds context menu based on the enumeration
|
|
</summary>
|
|
<param name="owner">Context menu owner</param>
|
|
<inheritdoc cref="M:Xarial.XCad.UI.Commands.IXCommandManagerExtension.AddCommandGroup``1(Xarial.XCad.UI.Commands.IXCommandManager)"/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Exceptions.CustomPanelControlNotCreatedException">
|
|
<summary>
|
|
Exception indicates that control of custom pane accessed when control has not been created yet
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Exceptions.CustomPanelControlNotCreatedException.#ctor">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Exceptions.DynamicControlHandlerMissingException">
|
|
<summary>
|
|
Indicates that not handler for dynamic controls
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.Exceptions.DynamicControlHandlerMissingException.#ctor(System.Reflection.PropertyInfo)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.ControlCreatedDelegate`1">
|
|
<summary>
|
|
Delegate of <see cref="E:Xarial.XCad.UI.IXCustomPanel`1.ControlCreated"/> event
|
|
</summary>
|
|
<typeparam name="TControl"></typeparam>
|
|
<param name="ctrl">Control</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PanelActivatedDelegate`1">
|
|
<summary>
|
|
Delegate of <see cref="E:Xarial.XCad.UI.IXCustomPanel`1.Activated"/> event
|
|
</summary>
|
|
<typeparam name="TControl">Type of control</typeparam>
|
|
<param name="sender">Activated tab</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.IXCustomPanel`1">
|
|
<summary>
|
|
Represents the panel with custom User Control
|
|
</summary>
|
|
<typeparam name="TControl">Type of user control</typeparam>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.IXCustomPanel`1.Activated">
|
|
<summary>
|
|
Raised when tab is activated
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.IXCustomPanel`1.ControlCreated">
|
|
<summary>
|
|
Raised when control is created
|
|
</summary>
|
|
<remarks>Depending on a specific CAD system control might be destroyed and created when document hiding</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.IXCustomPanel`1.IsControlCreated">
|
|
<summary>
|
|
Identifies if the control for this panel is created and it is safe to access <see cref="P:Xarial.XCad.UI.IXCustomPanel`1.Control"/> property, otherwise subscribe to <see cref="E:Xarial.XCad.UI.IXCustomPanel`1.ControlCreated"/> notification
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.IXCustomPanel`1.IsActive">
|
|
<summary>
|
|
Checks if this panel is active
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.IXCustomPanel`1.Control">
|
|
<summary>
|
|
Returns the specific User Control of this panel
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.IXCustomPanel`1.Close">
|
|
<summary>
|
|
Closes current panel
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.IXImage">
|
|
<summary>
|
|
Represents the image
|
|
</summary>
|
|
<remarks>This is usually used for icons</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.IXImage.Buffer">
|
|
<summary>
|
|
Byte data of this image
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.BaseImage">
|
|
<summary>
|
|
Represents base image
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.BaseImage.Buffer">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.BaseImage.#ctor(System.Byte[])">
|
|
<summary>
|
|
Base image constructor
|
|
</summary>
|
|
<param name="buffer">Image buffer</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.IXPopupWindow`1">
|
|
<summary>
|
|
Represents the popup window with custom hosted control
|
|
</summary>
|
|
<typeparam name="TWindow">Window to host</typeparam>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.IXPopupWindow`1.Closed">
|
|
<summary>
|
|
Event raised when popup is about to be closed
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.IXPopupWindow`1.ShowDialog">
|
|
<summary>
|
|
Shows window in modal state
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.IXPopupWindow`1.Show">
|
|
<summary>
|
|
Shows window in modeless state
|
|
</summary>
|
|
</member>
|
|
<!-- Badly formed XML comment ignored for member "T:Xarial.XCad.UI.PropertyPage.Attributes.BitmapButtonAttribute" -->
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.BitmapButtonAttribute.Icon">
|
|
<summary>
|
|
Image assigned to this icon
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.BitmapButtonAttribute.#ctor(System.Type,System.String,System.Int32,System.Int32)">
|
|
<param name="resType">Type of the static class (usually Resources)</param>
|
|
<param name="masterResName">Resource name of the master icon</param>
|
|
<param name="width">Button width</param>
|
|
<param name="height">Button height</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.BitmapOptionsAttribute">
|
|
<summary>
|
|
Additional options for bitmap control
|
|
</summary>
|
|
<remarks>Applied to property of type <see cref="T:System.Drawing.Image"/></remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.BitmapOptionsAttribute.Size">
|
|
<summary>
|
|
Size of the bitmap
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.BitmapOptionsAttribute.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Constructor for bitmap options
|
|
</summary>
|
|
<param name="width">Width of the bitmap</param>
|
|
<param name="height">Height of the bitmap</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.ICheckableGroupBoxAttribute">
|
|
<summary>
|
|
Indicates that this group should have a check box
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.CheckableGroupBoxAttribute">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.CheckableGroupBoxAttribute.MetadataTag">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.CheckableGroupBoxAttribute.#ctor(System.Object)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
<param name="metadataTag">Reference to property which defines the toggle state</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxAttribute">
|
|
<summary>
|
|
Indicates that the current property must be rendered as combo box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxAttribute.#ctor(System.Type,System.Object[])">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxAttribute.#ctor(System.Object[])">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxOptionsAttribute">
|
|
<summary>
|
|
Provides additional options for the drop-down list box
|
|
</summary>
|
|
<remarks>Must be applied to the property of <see cref="T:System.Enum"/></remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxOptionsAttribute.Style">
|
|
<summary>
|
|
Specific rendering style of the combobox
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxOptionsAttribute.SelectDefaultValue">
|
|
<summary>
|
|
Instructs to select the default value (if available) to avoid the control with deselected value on start
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ComboBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.ComboBoxStyle_e,System.Boolean)">
|
|
<summary>
|
|
Constructor for specifying style of combo box
|
|
</summary>
|
|
<param name="style">Specific style applied for combo box control</param>
|
|
<param name="selectDefaultValue">Instructs to select the default value (if available) to avoid the control with deselected value on start</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.ControlOptionsAttribute">
|
|
<summary>
|
|
Generic options for all controls
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ControlOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.AddControlOptions_e,Xarial.XCad.UI.PropertyPage.Enums.ControlLeftAlign_e,System.Drawing.KnownColor,System.Drawing.KnownColor,System.Int16,System.Int16,System.Int16,System.Int16,Xarial.XCad.UI.PropertyPage.Enums.ControlOnResizeOptions_e)">
|
|
<summary>
|
|
Constructor allowing to specify control common parameters
|
|
</summary>
|
|
<param name="opts">Generic control options</param>
|
|
<param name="align">Control alignment options</param>
|
|
<param name="backgroundColor">Background color of control. Use 0 for default color</param>
|
|
<param name="textColor">Color of the text on the control. Use 0 for default color</param>
|
|
<param name="left">Left alignment of the control. Use -1 for default alignment</param>
|
|
<param name="top">Top alignment of the control. Use -1 to align the control under the previous control</param>
|
|
<param name="width">Width of the control. Use -1 for auto width</param>
|
|
<param name="height">Height of the control in property manager page dialog box units. Use -1 for the auto height</param>
|
|
<param name="resizeOptions">Options to resize</param>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.ControlTagAttribute.Tag">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnAttribute">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnAttribute.Dependencies">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnAttribute.DependencyHandler">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.IDependentOnMetadataAttribute">
|
|
<summary>
|
|
Indicates that the state of this control depends on the <see cref="T:Xarial.XCad.UI.PropertyPage.Base.IMetadata"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.IDependentOnMetadataAttribute.Dependencies">
|
|
<summary>
|
|
Metadata tags
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.IDependentOnMetadataAttribute.DependencyHandler">
|
|
<summary>
|
|
Dependency handler resolving the control state
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnMetadataAttribute">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnMetadataAttribute.Dependencies">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnMetadataAttribute.DependencyHandler">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.DynamicControlsAttribute">
|
|
<summary>
|
|
Indicates that this property provides dynamic control for property page
|
|
</summary>
|
|
<remarks>Specify the handler in <see cref="M:Xarial.XCad.Extensions.IXExtension.CreatePage``1(Xarial.XCad.UI.PropertyPage.Delegates.CreateDynamicControlsDelegate)"/> to provide controls</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.DynamicControlsAttribute.Tag">
|
|
<summary>
|
|
User tag
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.DynamicControlsAttribute.#ctor">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.DynamicControlsAttribute.#ctor(System.Object)">
|
|
<summary>
|
|
Constructor with tag
|
|
</summary>
|
|
<param name="tag">Tag to associate with dynamic controls</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.GroupBoxOptions_e">
|
|
<summary>
|
|
Group box options
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.PropertyPage.Attributes.GroupBoxOptions_e.Collapsed">
|
|
<summary>
|
|
Display the group collapsed by default
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.IGroupBoxOptionsAttribute">
|
|
<summary>
|
|
Additional options for the group box control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.IGroupBoxOptionsAttribute.Options">
|
|
<summary>
|
|
Options of the group box
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.GroupBoxOptionsAttribute">
|
|
<inheritdoc/>>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.GroupBoxOptionsAttribute.Options">
|
|
<inheritdoc/>>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.HelpAttribute">
|
|
<summary>
|
|
Provides the additional help links for the page
|
|
</summary>
|
|
<remarks>Applied to the model class</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.HelpAttribute.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Constructor for specifying links to help resources
|
|
</summary>
|
|
<param name="helpLink">Link to help documentation</param>
|
|
<param name="whatsNewLink">Link to what's new page</param>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.ItemsSourceControlAttribute.ItemsSource">
|
|
<summary>
|
|
Tag of the metadata property (decorated with <see cref="T:Xarial.XCad.UI.PropertyPage.Attributes.MetadataAttribute"/>) which contains the items source for this combo box
|
|
</summary>
|
|
<remarks>Target property must be <see cref="T:System.Collections.IEnumerable"/> </remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ItemsSourceControlAttribute.#ctor(System.Type,System.Object[])">
|
|
<summary>
|
|
Creates a combo box with custom items provider
|
|
</summary>
|
|
<param name="customItemsProviderType">Type of the <see cref="T:Xarial.XCad.UI.PropertyPage.Services.ICustomItemsProvider"/> which creates items source</param>
|
|
<param name="dependencies">Optional control dependencies</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ItemsSourceControlAttribute.#ctor(System.Object[])">
|
|
<summary>
|
|
Creates combo box with static items
|
|
</summary>
|
|
<param name="items"></param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxAttribute">
|
|
<summary>
|
|
Indicates that the current property must be rendered as list box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxAttribute.#ctor">
|
|
<summary>
|
|
Use this constructor on the <see cref="T:System.Enum"/> to render enum as list box
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxAttribute.#ctor(System.Type,System.Object[])">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxAttribute.#ctor(System.Object[])">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxOptionsAttribute">
|
|
<summary>
|
|
Provides additional options for the list box
|
|
</summary>
|
|
<remarks>Must be applied to the property decorated with <see cref="T:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxAttribute"/></remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxOptionsAttribute.Style">
|
|
<summary>
|
|
Specific rendering style of the listbox
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.ListBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.ListBoxStyle_e)">
|
|
<summary>
|
|
Constructor for specifying style of list box
|
|
</summary>
|
|
<param name="style">Specific style applied for list box control</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.MessageAttribute">
|
|
<summary>
|
|
Attributes allows to specify the message to be displayed in the property manager page
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.MessageAttribute.#ctor(System.String,System.String,Xarial.XCad.UI.PropertyPage.Enums.PageMessageVisibility,Xarial.XCad.UI.PropertyPage.Enums.PageMessageExpanded)">
|
|
<summary>
|
|
Constructor to specify message and its parameters
|
|
</summary>
|
|
<param name="text">Text to be displayed in the message</param>
|
|
<param name="caption">Message box caption</param>
|
|
<param name="visibility">Visibility option</param>
|
|
<param name="expanded">Expansion state</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.MetadataAttribute">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.MetadataAttribute.Tag">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.MetadataAttribute.#ctor(System.Object)">
|
|
<summary>
|
|
Marks this property as metadata
|
|
</summary>
|
|
<param name="tag">Tag of the metadata</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.NumberBoxOptionsAttribute">
|
|
<summary>
|
|
Provides additional options for number box control
|
|
</summary>
|
|
<remarks>Applied to all numeric properties (i.e. <see cref="T:System.Double"/>, <see cref="T:System.Int32"/>)</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.NumberBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.NumberBoxStyle_e)">
|
|
<summary>
|
|
Constructor for specifying number box options
|
|
</summary>
|
|
<param name="style">Number box style</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.NumberBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.NumberBoxUnitType_e,System.Double,System.Double,System.Double,System.Boolean,System.Double,System.Double,Xarial.XCad.UI.PropertyPage.Enums.NumberBoxStyle_e)">
|
|
<inheritdoc cref = "M:Xarial.XCad.UI.PropertyPage.Attributes.NumberBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.NumberBoxStyle_e)" />
|
|
<param name="units">Number box units. 0 for not using units. If units are specified corresponding current user unit system will be used and the corresponding units marks will be displayed in the number box. Regardless of the current unit system the value will be stored in system units (MKS)</param>
|
|
<param name="minimum">Minimum allowed value for the number box</param>
|
|
<param name="maximum">Maximum allowed value for the number box</param>
|
|
<param name="increment">Default increment when up or down increment button is clicked</param>
|
|
<param name="inclusive">True sets the minimum-maximum as inclusive, false sets it as exclusive</param>
|
|
<param name="fastIncrement">Fast increment for mouse wheel or scroll</param>
|
|
<param name="slowIncrement">Slow increment for mouse wheel or scroll</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.OptionBoxAttribute">
|
|
<summary>
|
|
Attribute indicates that current property should be rendered as option box
|
|
</summary>
|
|
<remarks>This attribute is only applicable for <see cref="T:System.Enum">enum</see> types</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.OptionBoxAttribute.#ctor">
|
|
<summary>
|
|
Sets the current property as option box
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.OptionBoxOptionsAttribute">
|
|
<summary>
|
|
Additional options for option box control
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.OptionBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.OptionBoxStyle_e)">
|
|
<summary>
|
|
Assigns additional options (such as style) for this option box control
|
|
</summary>
|
|
<param name="style"></param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.IOrderAttribute">
|
|
<summary>
|
|
Defines the order of control generation based on the data model
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.IOrderAttribute.Order">
|
|
<summary>
|
|
Order of this control
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.OrderAttribute">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.OrderAttribute.Order">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.OrderAttribute.#ctor(System.Int32)">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
<param name="order"></param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.PageOptionsAttribute">
|
|
<summary>
|
|
Property manager page options
|
|
</summary>
|
|
<remarks>Applied to the main class of the data model</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.PageOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.PageOptions_e)">
|
|
<summary>Constructor for specifying property manager page options</summary>
|
|
<param name="opts">property page options</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.StandardSelectionColor_e">
|
|
<summary>
|
|
Represents the standard selection colors
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.PropertyPage.Attributes.StandardSelectionColor_e.Primary">
|
|
<summary>
|
|
Primary standard selection color
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.PropertyPage.Attributes.StandardSelectionColor_e.Secondary">
|
|
<summary>
|
|
Secondary standard selection color
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.PropertyPage.Attributes.StandardSelectionColor_e.Tertiary">
|
|
<summary>
|
|
Tertiary standard selection color
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute">
|
|
<summary>
|
|
Additional options for selection box control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.Style">
|
|
<summary>
|
|
Style of this selection box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.SelectionColor">
|
|
<summary>
|
|
Standard color of selection box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.Filters">
|
|
<summary>
|
|
Allowed entities filter for the selection
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.SelectionMark">
|
|
<summary>
|
|
Selection mark associated with this selection box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.CustomFilter">
|
|
<summary>
|
|
Custom filter for this selection box
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.Focused">
|
|
<summary>
|
|
Sets teh current selection box as default focus
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.SelectionBoxStyle_e,Xarial.XCad.UI.PropertyPage.Attributes.StandardSelectionColor_e)">
|
|
<summary>
|
|
Constructor for selection box options
|
|
</summary>
|
|
<param name="style">Selection box style</param>
|
|
<param name="selColor">Color of the selections in this selection box</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(Xarial.XCad.Base.Enums.SelectType_e[])">
|
|
<summary>
|
|
Constructor for selection box options
|
|
</summary>
|
|
<param name="filters">Filters allowed for selection into this selection box</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(System.Int32,Xarial.XCad.Base.Enums.SelectType_e[])">
|
|
<inheritdoc cref="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(Xarial.XCad.Base.Enums.SelectType_e[])"/>
|
|
<param name="mark">Selection mark. If multiple selections box are used - use different selection marks for each of them
|
|
to differentiate the selections</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(System.Type,Xarial.XCad.Base.Enums.SelectType_e[])">
|
|
<inheritdoc cref="!:SelectionBoxOptionsAttribute(int, Type, SelectionBoxStyle_e, int, SelectType_e[])"/>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(System.Int32,System.Type,Xarial.XCad.UI.PropertyPage.Enums.SelectionBoxStyle_e,Xarial.XCad.UI.PropertyPage.Attributes.StandardSelectionColor_e,Xarial.XCad.Base.Enums.SelectType_e[])">
|
|
<inheritdoc cref="M:Xarial.XCad.UI.PropertyPage.Attributes.SelectionBoxOptionsAttribute.#ctor(System.Int32,Xarial.XCad.Base.Enums.SelectType_e[])"/>
|
|
<param name="customFilter">Type of custom filter of <see cref="T:Xarial.XCad.UI.PropertyPage.Services.ISelectionCustomFilter"/> for custom logic for filtering selection objects</param>
|
|
<exception cref="T:System.InvalidCastException"/>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.StandardControlIconAttribute">
|
|
<summary>
|
|
Provides additional attribution options (i.e. icons, labels, tooltips etc.) for all controls
|
|
</summary>
|
|
<remarks>Can be applied to any property which is bound to the property manager page control</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.StandardControlIconAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.BitmapLabelType_e)">
|
|
<summary>Constructor allowing specify the standard icon</summary>
|
|
<param name="label">Control label</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.TabAttribute">
|
|
<summary>
|
|
Attribute indicates that current property or class should be rendered as tab box
|
|
</summary>
|
|
<remarks>This attribute is only applicable for complex types which contain nested properties</remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.TabAttribute.#ctor">
|
|
<summary>
|
|
Sets the current property as tab container
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Attributes.TextBoxOptionsAttribute">
|
|
<summary>
|
|
Additional options for text box control
|
|
</summary>
|
|
<remarks>Applied to property of type <see cref="T:System.String"/></remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Attributes.TextBoxOptionsAttribute.#ctor(Xarial.XCad.UI.PropertyPage.Enums.TextBoxStyle_e)">
|
|
<summary>
|
|
Constructor for text box options
|
|
</summary>
|
|
<param name="style">Text box control style</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.ControlObjectValueChangedDelegate">
|
|
<summary>
|
|
Delegate of <see cref="E:Xarial.XCad.UI.PropertyPage.Base.IControl.ValueChanged"/> event
|
|
</summary>
|
|
<param name="sender">Control</param>
|
|
<param name="newValue">New value of the control</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.IControl">
|
|
<summary>
|
|
Represents the control in the page
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.PropertyPage.Base.IControl.ValueChanged">
|
|
<summary>
|
|
Fired when the value of the control has been changed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControl.Enabled">
|
|
<summary>
|
|
Manages the enable state of the control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControl.Visible">
|
|
<summary>
|
|
Manages the visibility of the control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControl.Id">
|
|
<summary>
|
|
Identifier of this control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControl.Tag">
|
|
<summary>
|
|
Custom tag associated with this control via <see cref="T:Xarial.XCad.UI.PropertyPage.Base.IControlTagAttribute"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Base.IControl.GetValue">
|
|
<summary>
|
|
Gets the value from this control
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Base.IControl.SetValue(System.Object)">
|
|
<summary>
|
|
Sets the value to this control
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor">
|
|
<summary>
|
|
Describes the control in this property page
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.DisplayName">
|
|
<summary>
|
|
Display name of the control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.Description">
|
|
<summary>
|
|
Tooltip of the control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.Name">
|
|
<summary>
|
|
Unique name (id) of the control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.Icon">
|
|
<summary>
|
|
Icon of the control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.DataType">
|
|
<summary>
|
|
Object type this control associated with
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.GetValue(System.Object)">
|
|
<summary>
|
|
Gets the value from the object associated with the control
|
|
</summary>
|
|
<param name="context">Object context</param>
|
|
<returns>Value</returns>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.SetValue(System.Object,System.Object)">
|
|
<summary>
|
|
Sets the value to the context of the associated object
|
|
</summary>
|
|
<param name="context">Object context</param>
|
|
<param name="value">Value to set</param>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlDescriptor.Attributes">
|
|
<summary>
|
|
Atributes of this control
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IControlTagAttribute.Tag">
|
|
<summary>
|
|
Tag associated with the control
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.IDependentOnAttribute">
|
|
<summary>
|
|
Marks the current control to be dependent on other control values
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IDependentOnAttribute.DependencyHandler">
|
|
<summary>
|
|
Handler to resolve dependencies
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IDependentOnAttribute.Dependencies">
|
|
<summary>
|
|
List of control tags this control dependent on
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.IHasMetadataAttribute">
|
|
<summary>
|
|
Indicates that this binding uses metadata
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IHasMetadataAttribute.MetadataTag">
|
|
<summary>
|
|
Tag of metadata linked to <see cref="P:Xarial.XCad.UI.PropertyPage.Base.IMetadataAttribute.Tag"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.IMetadata">
|
|
<summary>
|
|
Represents the custom metadata which is attached to binding
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IMetadata.Value">
|
|
<summary>
|
|
Value associated with the metadata
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.PropertyPage.Base.IMetadata.Changed">
|
|
<summary>
|
|
Notifies when metadata is changed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IMetadata.Model">
|
|
<summary>
|
|
Model associated with this metadata
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Base.IMetadataAttribute">
|
|
<summary>
|
|
Represents the custom metadata which is used by controls
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Base.IMetadataAttribute.Tag">
|
|
<summary>
|
|
Tag of the metadata
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Delegates.CreateDynamicControlsDelegate">
|
|
<summary>
|
|
Handler of dynamic controls in the proeprty page
|
|
</summary>
|
|
<param name="tag">Control tag</param>
|
|
<returns>Dynamic control descriptors</returns>
|
|
</member>
|
|
<member name="F:Xarial.XCad.UI.PropertyPage.Enums.ListBoxStyle_e.Sorted">
|
|
<summary>
|
|
Sorts items in the ascending order
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.IXCustomControl">
|
|
<summary>
|
|
Represents the custom control hosted in the page
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.PropertyPage.IXCustomControl.ValueChanged">
|
|
<summary>
|
|
Raised when data context of this control is changed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.IXCustomControl.Value">
|
|
<summary>
|
|
Returns the data context of this control
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1">
|
|
<summary>
|
|
Represents native proeprty page to manage entity parameters
|
|
</summary>
|
|
<typeparam name="TDataModel"></typeparam>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1.DataChanged">
|
|
<summary>
|
|
Fired when the data is changed (i.e. text box changed, combobox selection changed etc.)
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1.Closing">
|
|
<summary>
|
|
Fired when property page is about to be closed. Use the argument to provide additional instructions
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1.Closed">
|
|
<summary>
|
|
Fired when property manager page is closed
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1.Show(`0)">
|
|
<summary>
|
|
Opens the property page with the specified data model
|
|
</summary>
|
|
<param name="model">Pointer to an instance of the bound data model</param>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1.Close(System.Boolean)">
|
|
<summary>
|
|
Closes the current page
|
|
</summary>
|
|
<param name="cancel">Cancel the current page or OK</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Services.ICustomItemsProvider">
|
|
<summary>
|
|
Enables the providing of custom items
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Services.ICustomItemsProvider.ProvideItems(Xarial.XCad.IXApplication,Xarial.XCad.UI.PropertyPage.Base.IControl[])">
|
|
<summary>
|
|
Called when items need to be provided to the control
|
|
</summary>
|
|
<param name="app">Application</param>
|
|
<param name="dependencies">Control dependencies</param>
|
|
<returns>Items</returns>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Services.CustomItemsProvider`1">
|
|
<summary>
|
|
Type safe version of <see cref="T:Xarial.XCad.UI.PropertyPage.Services.ICustomItemsProvider"/>
|
|
</summary>
|
|
<typeparam name="TItem">Item type</typeparam>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Services.IDependencyHandler">
|
|
<summary>
|
|
Handling the dynamic control dependencies
|
|
</summary>
|
|
<remarks>This is asigned via <see cref="T:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnAttribute"/></remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Services.IDependencyHandler.UpdateState(Xarial.XCad.IXApplication,Xarial.XCad.UI.PropertyPage.Base.IControl,Xarial.XCad.UI.PropertyPage.Base.IControl[])">
|
|
<summary>
|
|
Invokes when any of the dependencies controls changed
|
|
</summary>
|
|
<param name="app">Main application</param>
|
|
<param name="source">This control to update state on</param>
|
|
<param name="dependencies">List of dependencies controls</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Services.IMetadataDependencyHandler">
|
|
<summary>
|
|
Handling the dynamic control dependencies
|
|
</summary>
|
|
<remarks>This is asigned via <see cref="T:Xarial.XCad.UI.PropertyPage.Attributes.DependentOnAttribute"/></remarks>
|
|
</member>
|
|
<member name="M:Xarial.XCad.UI.PropertyPage.Services.IMetadataDependencyHandler.UpdateState(Xarial.XCad.IXApplication,Xarial.XCad.UI.PropertyPage.Base.IControl,Xarial.XCad.UI.PropertyPage.Base.IMetadata[])">
|
|
<summary>
|
|
Invokes when any of the dependencies controls changed
|
|
</summary>
|
|
<param name="app">Main application</param>
|
|
<param name="source">This control to update state on</param>
|
|
<param name="metadata">List of metadata dependencies</param>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg">
|
|
<summary>
|
|
Represents the parameter of <see cref="E:Xarial.XCad.UI.PropertyPage.IXPropertyPage`1.Closing"/> notification
|
|
</summary>
|
|
<remarks>If <see cref="P:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg.Cancel"/> parameter is set to true and <see cref="P:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg.ErrorTitle"/>
|
|
and <see cref="P:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg.ErrorMessage"/> are not empty. Framework will display the error popup box
|
|
next to the property manager page</remarks>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg.Cancel">
|
|
<summary>
|
|
True to cancel the closing of property manager page
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg.ErrorTitle">
|
|
<summary>
|
|
Title of the error to be displayed to the user or empty string if no error to be displayed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.PropertyPage.Structures.PageClosingArg.ErrorMessage">
|
|
<summary>
|
|
Message of the error to be displayed to the user or empty string if no error to be displayed
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xarial.XCad.UI.Structures.ButtonGroupSpec">
|
|
<summary>
|
|
Defines the group of buttons
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.Structures.ButtonGroupSpec.Title">
|
|
<summary>
|
|
Title of the group
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.Structures.ButtonGroupSpec.Tooltip">
|
|
<summary>
|
|
Help text (tooltip) of the group
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xarial.XCad.UI.Structures.ButtonGroupSpec.Icon">
|
|
<summary>
|
|
Group icon
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|