Get VBA Project

Introduction

This example explains how to get VBA project using Aspose.Tasks Cloud API in your applications. You can use our REST API with any language: .NET, Java, PHP, Ruby, Rails, Python, jQuery and many more..

API Information

API	Type	Description	Resource Link
/tasks/{name}/vbaproject	GET	Read VBA Project from a MPP File	GetVbaProject

cURL Example

Request


curl -X GET "https://api.aspose.cloud/v3.0/tasks/Home%20move%20plan.mpp/vbaproject" -H "accept: application/json"

Response


{
  "code": 0,
  "status": "string",
  "vbaProject": {
    "compilationArguments": "string",
    "description": "string",
    "helpContextId": 0,
    "helpFile": "string",
    "modules": [
      {
        "attributes": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "name": "string",
        "sourceCode": "string"
      }
    ],
    "name": "string",
    "references": [
      {
        "libIdentifier": "string",
        "name": "string"
      }
    ]
  }
}

SDKs

The Aspose.Tasks Cloud SDKs can be downloaded from the following page: Available SDKs

SDK Examples

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet/
	var remoteName = await UploadFileToStorageAsync("VbaProject3.mpp");
	var vbaResponse = await TasksApi.GetVbaProjectAsync(new GetVbaProjectRequest()
	{
	Name = remoteName,
	Folder = this.DataFolder
	});

	Assert.AreEqual((int)HttpStatusCode.OK, vbaResponse.Code);
	Assert.IsNotNull(vbaResponse.VbaProject);
	Assert.IsNotNull(vbaResponse.VbaProject.Modules);

	Assert.AreEqual(7, vbaResponse.VbaProject.Modules.Count);
	Assert.AreEqual("Module1", vbaResponse.VbaProject.Modules[0].Name);
	Assert.IsTrue(vbaResponse.VbaProject.Modules[0].SourceCode.StartsWith("Type MEMORYSTATUS"));

view raw Examples-GetVbaProject.cs hosted with ❤ by GitHub

PHP

	<?
	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php/
	$remoteName = "GetVbaProject.mpp";
	$folder = $this->uploadFile("VbaProject3.mpp", $remoteName, '');

	$response = $this->tasks->getVbaProject(new Requests\GetVbaProjectRequest($remoteName, $folder));


	Assert::assertEquals(200, $response->getCode());
	Assert::assertNotNull($response->getVbaProject());
	Assert::assertNotNull($response->getVbaProject()->getModules());
	Assert::assertEquals(7, count($response->getVbaProject()->getModules()));
	Assert::assertEquals("Module1", $response->getVbaProject()->getModules()[0]->getName());
	Assert::assertTrue(strpos($response->getVbaProject()->getModules()[0]->getSourceCode(), 'Type MEMORYSTATUS') === 0);

view raw Example-getVbaProject.php hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python
	filename = 'VbaProject3.mpp'
	self.upload_file(filename)
	get_request = GetVbaProjectRequest(filename)
	get_result = self.tasks_api.get_vba_project(get_request)
	self.assertIsNotNone(get_result)
	self.assertIsInstance(get_result, VbaProjectResponse)
	self.assertIsNotNone(get_result.vba_project.modules)
	self.assertEqual(7, len(get_result.vba_project.modules))
	self.assertEqual('Module1', get_result.vba_project.modules[0].name)
	self.assertTrue(get_result.vba_project.modules[0].source_code.startswith('Type MEMORYSTATUS'))

view raw get_vba_project.py hosted with ❤ by GitHub

Node.js

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-node

	const fileName = "VbaProject3.mpp";
	const localPath = "./Data/" + fileName;
	const remotePath = "Temp/Data";
	const remoteFullPath = remotePath + "/" + fileName;

	await tasksApi.uploadFileToStorage(remoteFullPath, localPath);

	const request = new GetVbaProjectRequest();
	request.name = fileName;
	request.folder = remotePath;

	const result = await tasksApi.getVbaProject(request);

	expect(result.response.statusCode).to.equal(200);
	expect(result.body.vbaProject).is.not.undefined.and.not.null;
	expect(result.body.vbaProject.modules).is.not.undefined.and.not.null;
	expect(result.body.vbaProject.modules.length).to.equal(7);
	expect(result.body.vbaProject.modules[0].name).to.equal("Module1");
	expect(result.body.vbaProject.modules[0].sourceCode).to.satisfy(c => c.startsWith("Type MEMORYSTATUS"));// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-node

	const fileName = "VbaProject3.mpp";
	const localPath = "./Data/" + fileName;
	const remotePath = "Temp/Data";
	const remoteFullPath = remotePath + "/" + fileName;

	await tasksApi.uploadFileToStorage(remoteFullPath, localPath);

	const request = new GetVbaProjectRequest();
	request.name = fileName;
	request.folder = remotePath;

	const result = await tasksApi.getVbaProject(request);

	expect(result.response.statusCode).to.equal(200);
	expect(result.body.vbaProject).is.not.undefined.and.not.null;
	expect(result.body.vbaProject.modules).is.not.undefined.and.not.null;
	expect(result.body.vbaProject.modules.length).to.equal(7);
	expect(result.body.vbaProject.modules[0].name).to.equal("Module1");
	expect(result.body.vbaProject.modules[0].sourceCode).to.satisfy(c => c.startsWith("Type MEMORYSTATUS"));

view raw getVbaProject.ts hosted with ❤ by GitHub

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-go/
	client, ctx := UploadTestFileToStorage(t, localFileName, remoteBaseTestDataFolder+"/"+remoteFileName)

	opts := &requests.GetVbaProjectOpts{
	Name: remoteFileName,
	Folder: optional.NewString(remoteBaseTestDataFolder),
	}
	result, _, err := client.TasksApi.GetVbaProject(ctx, opts)
	if err != nil {
	t.Error(err)
	}
	assert.Equal(t, int32(200), result.Code)
	assert.NotNil(t, result.VbaProject)
	assert.NotNil(t, result.VbaProject.Modules)
	assert.Equal(t, 7, len(result.VbaProject.Modules))
	assert.Equal(t, "Module1", result.VbaProject.Modules[0].Name)
	assert.True(t, strings.HasPrefix(result.VbaProject.Modules[0].SourceCode, "Type MEMORYSTATUS"))

view raw Examples-GetVbaProject.go hosted with ❤ by GitHub

Java

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-java/
	String localFileName = "VbaProject3.mpp";
	String remoteFileName = TestInitializer.UploadFile(localFileName);

	GetVbaProjectRequest request = new GetVbaProjectRequest(remoteFileName, null, null);
	VbaProjectResponse result = TestInitializer.tasksApi.getVbaProject(request);
	assertNotNull(result);
	assertEquals(Integer.valueOf(200), result.getCode());
	assertNotNull(result.getVbaProject());
	assertNotNull(result.getVbaProject().getModules());
	assertEquals(7, result.getVbaProject().getModules().size());
	assertEquals("Module1", result.getVbaProject().getModules().get(0).getName());
	assertTrue(result.getVbaProject().getModules().get(0).getSourceCode().startsWith("Type MEMORYSTATUS"));

view raw Examples-GetVbaProject.java hosted with ❤ by GitHub