Share

Layer Object

Derived from: Style Object

Description

The Layer object represents a layer in a drawing document.

Methods

Name Description
ConvertToLocal Method that creates a local cached copy of a global style and returns the local style.
Copy Method that creates a new local Style object. The newly created style is returned.
Delete Method that deletes the Style/Layer/UnfoldMethod.
GetCustomLineType Method that returns information regarding the custom line type in use, or a failure if it is not a kCustomLineType.
GetReferenceKey Method that generates and returns the reference key for this entity.
SaveToGlobal Method that saves this style to the global repository. If a style with the same name is found in the repository, that style is updated.
SetCustomLineType Method that sets a custom line type to the entity from the specified .lin file. The method automatically changes the value of the LineType property to kCustomLineType.
UpdateFromGlobal Method that updates this style from the global repository.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AutomaticColor Property that gets and sets whether to use the default color for the layer. This property can only be set to True. Setting the Color property automatically sets this property to False.
Color Property that gets and sets the color used for the layer.
Comments Gets and sets comments associated with the style.
InternalName Property that returns the internal name of the style. The name is the internal English name of the standard style. This name will remain constant and is not affected by locale. This name is never displayed to the user. Note that this name is not guaranteed to be unique.
InUse Property that indicates if this style is in use.
LineType Property that gets and sets the line type override. Setting the property to kDefaultLineType restores the default line type. If the property returns kCustomLineType, the GetCustomLineType method can be used to get further details about the line type.
LineWeight Property that gets and sets the thickness of this primitive/object. If LineDefinitionSpace is set to kScreenSpace, this value is defined in pixels. If LineDefinitionSpace is set to kModelSpace, this value is defined in model units (centimeters).
Name Gets/Sets the name of the Style.
Parent Property returning the parent of this object.
Plot Property that gets and sets whether this layer is plotted. If set to False, the layer continues to display in the drawing but will neither get printed nor published.
ScaleByLineWeight Property that gets and sets whether to scale the line type based on the line weight value.
StyleLocation Property that returns the location of this style, i.e. local to the document, cached locally in the document, exists in the library. Styles that exist in the library cannot be edited.
StyleType Gets the type of the style.
Type Returns an ObjectTypeEnum indicating this object's type.
UpToDate Property that gets the up-to-date status of the style against the global repository.
Visible Property that gets and sets whether the layer is turned on or off.

Accessed From

AngularGeneralDimension.Layer, AutoCADBlock.Layer, Balloon.Layer, BaselineDimensionSet.Layer, BendNote.Layer, BreakOperation.Layer, Centerline.Layer, Centermark.Layer, ChainDimensionSet.Layer, ChamferNote.Layer, CustomTable.Layer, DetailDrawingView.BoundaryLayer, DiameterGeneralDimension.Layer, DrawingCurveSegment.Layer, DrawingDimension.Layer, DrawingNote.Layer, DrawingViewHatchRegion.Layer, DrawingViewLabel.Layer, DrawingWeldingSymbol.Layer, EdgeSymbolDefinition.Layer, FeatureControlFrame.Layer, GeneralDimension.Layer, GeneralNote.Layer, HoleTable.Layer, HoleTag.Layer, HoleThreadNote.Layer, LayersEnumerator.Item, LeaderNote.Layer, LinearGeneralDimension.Layer, ObjectDefaultsStyle.AngularDimensionLayer, ObjectDefaultsStyle.AuxiliaryViewLineLayer, ObjectDefaultsStyle.BalloonLayer, ObjectDefaultsStyle.BaselineDimensionLayer, ObjectDefaultsStyle.BendNoteLayer, ObjectDefaultsStyle.BendTableLayer, ObjectDefaultsStyle.BendTagLayer, ObjectDefaultsStyle.BorderGeometryLayer, ObjectDefaultsStyle.BorderTextLayer, ObjectDefaultsStyle.CenterlineLayer, ObjectDefaultsStyle.CentermarkLayer, ObjectDefaultsStyle.CenterOfGravityLayer, ObjectDefaultsStyle.ChainDimensionLayer, ObjectDefaultsStyle.ChamferNoteLayer, ObjectDefaultsStyle.ConfigurationTableLayer, ObjectDefaultsStyle.CropCutLineLayer, ObjectDefaultsStyle.DetailCutLineLayer, ObjectDefaultsStyle.DetailViewCalloutLayer, ObjectDefaultsStyle.DiameterDimensionLayer, ObjectDefaultsStyle.EdgeSymbolLayer, ObjectDefaultsStyle.FeatureControlFrameLayer, ObjectDefaultsStyle.GeneralNoteLayer, ObjectDefaultsStyle.HoleNoteLayer, ObjectDefaultsStyle.HoleTableLayer, ObjectDefaultsStyle.HoleTagLayer, ObjectDefaultsStyle.LeaderTextLayer, ObjectDefaultsStyle.LinearDimensionLayer, ObjectDefaultsStyle.OrdinateDimensionLayer, ObjectDefaultsStyle.OrdinateDimensionSetLayer, ObjectDefaultsStyle.OriginIndicatorLayer, ObjectDefaultsStyle.PartsListLayer, ObjectDefaultsStyle.PunchNoteLayer, ObjectDefaultsStyle.RadialDimensionLayer, ObjectDefaultsStyle.RevisionTableLayer, ObjectDefaultsStyle.RevisionTagLayer, ObjectDefaultsStyle.SectionBreakLineLayer, ObjectDefaultsStyle.SectionViewLineLayer, ObjectDefaultsStyle.SheetMetalPunchLayer, ObjectDefaultsStyle.Sketch3DGeometryLayer, ObjectDefaultsStyle.SketchedSymbolGeometryLayer, ObjectDefaultsStyle.SketchedSymbolLeaderLayer, ObjectDefaultsStyle.SketchedSymbolTextLayer, ObjectDefaultsStyle.SketchGeometryLayer, ObjectDefaultsStyle.SketchTextLayer, ObjectDefaultsStyle.SurfaceTextureLayer, ObjectDefaultsStyle.TableLayer, ObjectDefaultsStyle.ThreadNoteLayer, ObjectDefaultsStyle.TitleBlockGeometryLayer, ObjectDefaultsStyle.TitleBlockTextLayer, ObjectDefaultsStyle.TransitionSymbolLayer, ObjectDefaultsStyle.ViewLabelLayer, ObjectDefaultsStyle.WeldSymbolLayer, ObjectDefaultsStyle.WorkAxisLayer, ObjectDefaultsStyle.WorkPlaneLayer, ObjectDefaultsStyle.WorkPointLayer, OrdinateDimension.Layer, OrdinateDimensionSet.Layer, OriginIndicator.Layer, PartsList.Layer, PunchNote.Layer, RadiusGeneralDimension.Layer, RevisionCloudDefinition.Layer, RevisionTable.Layer, SketchArc.Layer, SketchArcProxy.Layer, SketchCircle.Layer, SketchCircleProxy.Layer, SketchControlPointSpline.Layer, SketchControlPointSplineProxy.Layer, SketchedSymbol.Layer, SketchEllipse.Layer, SketchEllipseProxy.Layer, SketchEllipticalArc.Layer, SketchEllipticalArcProxy.Layer, SketchEntity.Layer, SketchEquationCurve.Layer, SketchEquationCurveProxy.Layer, SketchFixedSpline.Layer, SketchFixedSplineProxy.Layer, SketchHatchRegion.Layer, SketchLine.Layer, SketchLineProxy.Layer, SketchOffsetSpline.Layer, SketchOffsetSplineProxy.Layer, SketchPoint.Layer, SketchPointProxy.Layer, SketchSpline.Layer, SketchSplineHandle.Layer, SketchSplineHandleProxy.Layer, SketchSplineProxy.Layer, SurfaceTextureSymbol.Layer, TextBox.Layer, TextBoxProxy.Layer, TransitionSymbolDefinition.Layer

Samples

Name Description
Moving sketch entities to a new layer This sample demonstrates the creation of a new layer and moving sketch entities onto this newly created layer.

Version

Introduced in version 10

Was this information helpful?