AcSmSheetSet (SSO)

Sheet set component.

Topics in this section

AcSmSheetSet.AddNewSheet Method (SSO)
Constructs a new sheet component. The new sheet is not automatically inserted into the collection.
AcSmSheetSet.Clear Method (SSO)
Resets and cleans up the object, leaving the object uninitialized.
AcSmSheetSet.CreateSubset Method (SSO)
Constructs a new subset component. The new subset is not inserted automatically into the collection.
AcSmSheetSet.GetAltPageSetups Method (SSO)
Retrieves the IAcSmFileReference component that references the template containing alternative page setups.
AcSmSheetSet.GetCalloutBlocks Method (SSO)
Returns a collection of callout block references that are associated with the sheet set.
AcSmSheetSet.GetCustomPropertyBag Method (SSO)
Retrieves the custom property bag of the component.
AcSmSheetSet.GetDatabase Method (SSO)
Retrieves the parent IAcSmDatabase object. If the method succeeds, the return value is S_OK. If the parent database cannot be found, S_FALSE is returned and the provided pointer is populated with null. All other return values indicate an error condition.
AcSmSheetSet.GetDefAltPageSetup Method (SSO)
Retrieves the IAcSmNamedAcDbObjectReference component that references the default page setup within the template containing alternative page setups.
AcSmSheetSet.GetDefDwtLayout Method (SSO)
Returns the IAcSmNamedAcDbObjectReference that points to the AcDbLayout to be used as a template for new sheet creation.
AcSmSheetSet.GetDefLabelBlk Method (SSO)
Returns the IAcSmNamedAcDbObjectReference component that references the label block definition for the sheet set.
AcSmSheetSet.GetDesc Method (SSO)
Retrieves the description of the component.
AcSmSheetSet.GetDirectlyOwnedObjects Method (SSO)
Returns an array of the directly owned objects. If the method succeeds, the return value is S_OKS_OK. If the parent database cannot be found, S_FALSES_FALSE is returned and the provided pointer is populated with null. All other return values indicate an error condition.
AcSmSheetSet.GetIsDirty Method (SSO)
If VARIANT_TRUE is returned, then the persistable component was modified and is committed when the owner AcSmDatabase is unlocked.
AcSmSheetSet.GetName Method (SSO)
Retrieves the Name property of the component.
AcSmSheetSet.GetNewSheetLocation Method (SSO)
Returns the IAcSmFileReference that points to the file system location where new sheets will be created.
AcSmSheetSet.GetObjectId Method (SSO)
Retrieves the IAcSmObjectId of the object. If the method succeeds, the return value is S_OK. If the parent database cannot be found, S_FALSE is returned and the provided pointer is populated with null. All other return values indicate an error condition.
AcSmSheetSet.GetOwner Method (SSO)
Retrieves a pointer to the owning IAcSmPersist parent object.
AcSmSheetSet.GetProjectMilestone Method (SSO)
Retrieves the ProjectMilestone property. Returns S_OK if successful.
AcSmSheetSet.GetProjectName Method (SSO)
Retrieves the project name associated with this sheet set. Returns S_OK if successful.
AcSmSheetSet.GetProjectNumber Method (SSO)
Retrieves the project number associated with this sheet set. Returns S_OK if successful.
AcSmSheetSet.GetProjectPhase Method (SSO)
Retrieves the ProjectPhase property. Returns S_OK if successful.
AcSmSheetSet.GetPromptForDwgName Method (SSO)
Retrieves the flag indicating whether the user interface should prompt for the name of a new drawing.
AcSmSheetSet.GetPromptForDwt Method (SSO)
Returns the Boolean flag that indicates if the application should prompt for DWT file.
AcSmSheetSet.GetPublishOptions Method (SSO)
This API was designed for internal use and has not been thoroughly tested.
AcSmSheetSet.GetResources Method (SSO)
Returns a collection of the resources associated with the sheet set.
AcSmSheetSet.GetSheetEnumerator Method (SSO)
Returns an enumerator of all components contained in this subset (ordered).
AcSmSheetSet.GetSheetSelSets Method (SSO)
Returns a collection of the sheet selection sets associated with the sheet set.
AcSmSheetSet.GetTypeName Method (SSO)
Retrieves the descriptive name representing the coclass. This method is used mainly by the filer.
AcSmSheetSet.GetViewCategories Method (SSO)
This API was designed for internal use and has not been thoroughly tested.
AcSmSheetSet.ImportSheet Method (SSO)
Constructs a new sheet component that references the existing layout pointed to by the provided AcSmAcDbLayoutReference.
AcSmSheetSet.InitNew Method (SSO)
Initialization of a newly created persistable object. This method and the Load method are the only two ways to initialize a persistable component.
AcSmSheetSet.InsertComponentAfter Method (SSO)
Inserts a sheet at the position specified.
AcSmSheetSet.InsertComponent Method (SSO)
Inserts a sheet at the position specified.
AcSmSheetSet.Load Method (SSO)
This API was designed for internal use and has not been thoroughly tested.
AcSmSheetSet.NotifyRegisteredEventHandlers Method (SSO)
Forces a given notification to all registered notification handlers.
AcSmSheetSet.Register Method (SSO)
Registers a callback notification handler and returns a unique cookie identifier for the handler.
AcSmSheetSet.RemoveSheet Method (SSO)
Removes the specified sheet component from the collection.
AcSmSheetSet.RemoveSubset Method (SSO)
Removes the specified subset component from the collection.
AcSmSheetSet.Save Method (SSO)
This API was designed for internal use and has not been thoroughly tested.
AcSmSheetSet.SetAltPageSetups Method (SSO)
Sets the IAcSmFileReference component that references the template containing alternative page setups.
AcSmSheetSet.SetDefAltPageSetup Method (SSO)
Sets the IAcSmNamedAcDbObjectReference component that references the default page setup within the template containing the alternative page setups.
AcSmSheetSet.SetDefDwtLayout Method (SSO)
Sets the AcSmAcDbLayoutReference that points to the AcDbLayout to be used as a template for new sheet creation.
AcSmSheetSet.SetDefLabelBlk Method (SSO)
Sets the AcSmAcDbBlockRecordReference component that references the label block definition for the sheet set.
AcSmSheetSet.SetDesc Method (SSO)
Sets the description of the component.
AcSmSheetSet.SetName Method (SSO)
Returns S_FALSE without setting the Name property of the component. The Name property of the component should be changed at the component level.
AcSmSheetSet.SetNewSheetLocation Method (SSO)
Sets the IAcSmFileReference that points to the location in the file system where new sheets are created.
AcSmSheetSet.SetOwner Method (SSO)
Sets the owner property of the IAcSmPersist object. The owning object should have a direct reference to this object.
AcSmSheetSet.SetProjectMilestone Method (SSO)
Sets the ProjectMilestone property. Returns S_OK if successful.
AcSmSheetSet.SetProjectName Method (SSO)
Sets the project name associated with this sheet set. Returns S_OK if successful.
AcSmSheetSet.SetProjectNumber Method (SSO)
Sets the project number associated with this sheet set. Returns S_OK if successful.
AcSmSheetSet.SetProjectPhase Method (SSO)
Sets the ProjectPhase property. Returns S_OK if successful.
AcSmSheetSet.SetPromptForDwgName Method (SSO)
Sets the flag indicating whether the user interface should prompt for the name of a new drawing.
AcSmSheetSet.SetPromptForDwt Method (SSO)
Sets the Boolean flag that indicates whether the application should prompt for a DWT file.
AcSmSheetSet.Sync Method (SSO)
Updates the sheet view components in the sheet set of the provided AcadDatabase object.
AcSmSheetSet.Unregister Method (SSO)
Unregisters a callback notification handler that was previously registered.
AcSmSheetSet.UpdateInMemoryDwgHints Method (SSO)
Updates the hints in the open drawings referenced in the subset.

Overview of Sheet Set Manager Objects (SSO)

AcSmSheetSet (SSO)

Related Concepts

Related Reference