Hide Table of Contents
Caption Property (IAttributeDefinition)

Gets or sets the text to display in the command window during a Block insertion.

.NET Syntax

Visual Basic (Declaration) 
Property Caption As System.String
C# 
System.string Caption {get; set;}
JavaScript 
get_Caption () : String
put_Caption (
   NewVal : String
)
COM native C++ 
HRESULT get_Caption(
   BSTR* Val
) 
HRESULT put_Caption( 
   BSTR NewVal
C++ 
DSRESULT get_Caption (
   dsString* Val
)
DSRESULT put_Caption(
   const dsString& NewVal
)

Property Value

Text to display in the command window during a Block insertion

Example

This code snippet shows how to write the captions, names, and values of the BlockAttribute definitions to a file.

COM native C++ 

void CAddinDumpManager::DumpAttributeDefinitions( CStdioFile& fileOutput, LPCWSTR tabStr, IBlockDefinitionPtr blkDefs )
{
    CString strPrint;
   
    _variant_t pVariantArrayAD = blkDefs->GetAttributeDefinitions();
    if( V_VT( &pVariantArrayAD ) != VT_EMPTY )
    {
        IAttributeDefinitionPtr *blkAttDefs = NULL;
        int countOfAttDefs = 0;
        TypeConverter::convertVariantArrayToPtrArray<IAttributeDefinitionPtr, IAttributeDefinition>( pVariantArrayAD, blkAttDefs, countOfAttDefs );

        strPrint.Format( L"\tAttribute definitions (%d):\r\n", countOfAttDefs );
        fileOutput.WriteString( strPrint );

        if( blkAttDefs && countOfAttDefs > 0)
        {
            for( int i = 0; i < countOfAttDefs; ++i )
            {
                bstr_t AttDefCaption= blkAttDefs[i]->GetCaption();
                strPrint.Format( L"\tCaption: %s\r\n", AttDefCaption.operator const wchar_t*() );
                fileOutput.WriteString( strPrint );

                bstr_t AttDefName= blkAttDefs[i]->GetName();
                strPrint.Format( L"\tName: %s\r\n", AttDefName.operator const wchar_t*() );
                fileOutput.WriteString(strPrint);

                bstr_t AttDefValue= blkAttDefs[i]->GetValue();
                strPrint.Format( L"\tValue: %s\r\n", AttDefValue.operator const wchar_t*() );
                fileOutput.WriteString( strPrint );

            }                           
            delete[] blkAttDefs;
        }
        else
            fileOutput.WriteString( L"\tERROR GetAttributeDefinitions\r\n" );
    }
    else
        fileOutput.WriteString( L"\tERROR GetAttributeDefinitions\r\n" );
}

 

 

This code snippet shows how to write the name, caption, and value of the BlockAttribute definition to a file, if the selected object is an IAttributeDefinition object.

COM native C++ 

        long selCount = dsSelManager->GetSelectedObjectCount( dsSelectionSetType_Current );
        strPrint.Format( L"Selected objects: (%d):\r\n", selCount );
        fileOutput.WriteString( strPrint );

        if( selCount > 0 )
        {        
            for( long i = 0; i < selCount; ++i )
            {
                //Get selected object type
                dsObjectType_e retObjType;
                IDispatchPtr selObj = dsSelManager->GetSelectedObject( dsSelectionSetType_Current, i, &retObjType );


                //If selected object is BlockAttribute definition
                if( dsAttributeDefinitionType == retObjType )
                {
                    IAttributeDefinitionPtr AttDefs( selObj );

                    //Get BlockAttribute definition name
                    bstr_t AttDefName = AttDefs->GetName();

                    strPrint.Format( L"Attribute definition (%s) \r\n", AttDefName.operator const wchar_t*() );
                    fileOutput.WriteString( strPrint );

                    //Get BlockAttribute definition caption
                    bstr_t AttDefCaption = AttDefs->GetCaption();

                    strPrint.Format( L"\tCaption: %s\r\n", AttDefCaption.operator const wchar_t*() );
                    fileOutput.WriteString( strPrint );

                    strPrint.Format( L"\tName: %s\r\n", AttDefName.operator const wchar_t*() );
                    fileOutput.WriteString( strPrint );
                       
                    //Get BlockAttribute definition value
                    bstr_t AttDefValue = AttDefs->GetValue();

                    strPrint.Format( L"\tValue: %s\r\n", AttDefValue.operator const wchar_t*() );
                    fileOutput.WriteString( strPrint );

Example

See Also

Availability

DraftSight V1R1


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Caption Property (IAttributeDefinition)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2020 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.21