Sample Code Revit Batch Processor 1.1.16 documentation

Contents:

This Page

duHast.Revit.SharedParameters.Data package

Subpackages

Submodules

duHast.Revit.SharedParameters.Data.shared_parameter_data_purge_Unused module

Family shared parameters purge unused utilities.

This will delete all shared parameter definitions which are not used by any family parameter.

  • requires a revit shared parameter processor object

duHast.Revit.SharedParameters.Data.shared_parameter_data_purge_Unused.purge_unused(doc, processor)

This will delete all shared parameter definitions which are not used by any family parameter in the family or nested families.

Parameters:
  • doc (Autodesk.Revit.DB.Document) – Current Revit model document.

  • processor (SharedParameterProcessor) – An RevitSharedParameterDataProcessor object containing all shared parameter information of the family document and any nested families.

Returns:

Result class instance.

  • True if all unused shared parameters where deleted successfully or none needed to be deleted. Otherwise False.

  • Result.message property updated in format: Found unused shared parameter: shared parameter Name [GUID]

On exception:

  • status (bool) will be False.

  • message will contain the exception message.

Return type:

Result

Module contents